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

Migrate user manual to MkDocs #1838

Closed
5 of 8 tasks
buhtz opened this issue Aug 11, 2024 · 2 comments · Fixed by #1899
Closed
5 of 8 tasks

Migrate user manual to MkDocs #1838

buhtz opened this issue Aug 11, 2024 · 2 comments · Fixed by #1899

Comments

@buhtz
Copy link
Member

buhtz commented Aug 11, 2024

This is a meta issue to coordinate and document the steps migrating our documentation to MkDocs.

HowTo generate doc on your local system using MkDocs

To generate the doc on your local system, navigate into /doc/manual. Now you have to options: 1) Run mkdocs build to generate HTML and open /doc/manual/html/index.html, or 2) run mkdocs serve and start your browser with http://127.0.0.1:8000 ("localhost:8000" doesn't work on my system). You can modify the config and the content (md-files) life while the server runs.

@buhtz
Copy link
Member Author

buhtz commented Sep 22, 2024

The user manual now is build with MkDocs by Read The Docs.
The repo bit-team/doc now has a deprecated message in the beginning of it README.md and I set the repo into "archive" mode.

@buhtz
Copy link
Member Author

buhtz commented Sep 23, 2024

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

Successfully merging a pull request may close this issue.

1 participant