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

More documentation-related improvements #171

Open
Morwenn opened this issue Sep 28, 2020 · 0 comments
Open

More documentation-related improvements #171

Morwenn opened this issue Sep 28, 2020 · 0 comments

Comments

@Morwenn
Copy link
Owner

Morwenn commented Sep 28, 2020

This issue is a direct follow-up to #157, a big picture issue about the future possible improvements of the tooling around the documentation.

Any change to the tooling in the direction of more automation and automatic checks or replacements should be thoroughly documented in the documentation page dedicated to tooling.

Future version placeholder

Currently we have to know the next version number in order to add comments such as New in version XXX or Changed in version YYY in the documentation. Following Catch2's lead, we could use a placeholder such as cpp-sort-version-next in the documentation file and have a small script replace those occurrences by the known version number. Such as script would be run before the release and would most likely help me not forgetting to change version numbers before a release.

MarkdownSnippets

MarkdownSnippets is a tool that allows to test the code embedded in Markdown files. Setting it up would ensure that all the code snippets in the documentation are actually correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant