Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic documentation with MKdocs #184

Merged
merged 14 commits into from
Oct 29, 2024
Merged

Add basic documentation with MKdocs #184

merged 14 commits into from
Oct 29, 2024

Conversation

Ludee
Copy link
Member

@Ludee Ludee commented Oct 23, 2024

Summary of the discussion

Add basic documentation with MKdocs.

Type of change (CHANGELOG.md)

Added

  • Add basic documentation with MKdocs (#184)

Workflow checklist

Automation

Closes #118

PR-Assignee

Reviewer

  • 🐙 Follow the Reviewer Guidelines
  • 🐙 Provided feedback and show sufficient appreciation for the work done

@Ludee Ludee added part: documentation 📖 Improvements or additions to documentation type: enhancement ⚙️ Improvement of an existing feature labels Oct 23, 2024
@Ludee Ludee requested a review from jh-RLI October 23, 2024 18:45
@Ludee Ludee self-assigned this Oct 23, 2024
@Ludee Ludee marked this pull request as ready for review October 23, 2024 18:47
Copy link
Contributor

@jh-RLI jh-RLI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the requirements-docs.txt. Other than that, I think this is a good start.

@Ludee Ludee merged commit e313fab into develop Oct 29, 2024
2 checks passed
@Ludee Ludee deleted the feature-118-mkdocs branch October 29, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: documentation 📖 Improvements or additions to documentation type: enhancement ⚙️ Improvement of an existing feature
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

A proper documentation is missing
2 participants