All the documentation source files that were previously in the root of the project are now under /docs
Some source files have been restructured or split up into separate files. I've done this to populate the top nav bar. The current navigation structure is not ideal and should be updated in follow up PRs.
The contents of the README.md has been replaced with guidelines on how to contribute to the documentation.
The original content has been moved to /docs/index.md
A CI workflow has been added that deploys automatically whenever there is a push (or PR merge) on main.
Cool new features
Inline PlantUML diagrams
Automatic compilation of PlantUML source files
Potential future features
If we want to make it simpler for people that are unfamiliar with GitHub to leave comments on the documentation, one of the following tools could be used. These, however, do require the commenter to have a GitHub account.
Utterances - Uses the GitHub Issues API as a backend for storing and fetching website comments
Giscus - Same as Utterances, but using the GitHub Discussions API
This PR adds support for the Jekyll static site generator and automatic deployment to Github Pages.
Notable changes
/docsREADME.mdhas been replaced with guidelines on how to contribute to the documentation./docs/index.mdmain.Cool new features
Potential future features
If we want to make it simpler for people that are unfamiliar with GitHub to leave comments on the documentation, one of the following tools could be used. These, however, do require the commenter to have a GitHub account.
Signed-off-by: Karim Stekelenburg karim@animo.id