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

Build a transverse documentation website of the whole organization via Mkdocs #1

Merged
merged 68 commits into from
May 12, 2024

Conversation

Baptouuuu
Copy link
Member

@Baptouuuu Baptouuuu commented Apr 20, 2024

This PR will publish a new documentation at http://innmind.github.io/documentation/

The main goals of this documentation are:

  • put in writing the design principles used throughout Innmind
  • provide a way to progressively learn from low to high abstractions and how they fit together

This documentation does not intend to be an extensive one. Each documentation is still the place to learn all the capabilities of each one.

@Baptouuuu Baptouuuu self-assigned this Apr 20, 2024
@Baptouuuu
Copy link
Member Author

The experience building this documentation has been better than the traditional markdown files in GitHub used in other projects as it provides ways to add extra information without getting in the way of the main content.

All packages with an extensive documentation will, in time, migrate to documentations built with mkdocs.

@Baptouuuu Baptouuuu marked this pull request as ready for review May 11, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant