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

docs: deploy dedicated docs pages #174

Closed
uniqueg opened this issue Aug 23, 2024 · 0 comments · Fixed by #175
Closed

docs: deploy dedicated docs pages #174

uniqueg opened this issue Aug 23, 2024 · 0 comments · Fixed by #175

Comments

@uniqueg
Copy link
Member

uniqueg commented Aug 23, 2024

Is your feature request related to a problem? Please describe.

The current documentation is not nicely structured.

Describe the solution you'd like

Use GH Pages or Read the Docs to deploy dedicated docs pages. To build on the markdown docs we already have, we can leverage MKDocs and Material for MKDocs to build beautiful docs pages, similar to how we do for ZARP-cli's docs. We can then deploy them via GitHub pages.

Describe alternatives you've considered

Alternatively, we could use RST to write docs and/or Read the Docs to host docs.

Additional context

N/A

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 a pull request may close this issue.

1 participant