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 a project site, roadmap and initial documentation pages #27

Merged
merged 7 commits into from
Jul 14, 2024

Conversation

oleg-nenashev
Copy link
Collaborator

Creates a small documentation site, powered by Material for MkDocs. More to be implemented there, but it

Initial structure includes:

  • Landing, as README now
  • Documentation pages for C/C++
  • Public Roadmap
  • Devcontainer and CI/CD for the site development

Later, I will migrate more content out of README to keep it simple. In particular, an installation guide and a quickstart tutorial will need to be detached, and the Modules content will be moved over

Closes #8

@oleg-nenashev oleg-nenashev added the documentation Improvements or additions to documentation label Jul 14, 2024
@oleg-nenashev oleg-nenashev merged commit 08227fd into main Jul 14, 2024
2 checks passed
@oleg-nenashev oleg-nenashev deleted the docs-site branch July 14, 2024 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Initial Documentation structure
1 participant