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.

Sign up for GitHub

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

Jump to bottom

Include user guide on GitHub Pages #346

Open
Tracked by #349
alexdewar opened this issue Oct 10, 2023 · 0 comments
Open
Tracked by #349

Include user guide on GitHub Pages #346

alexdewar opened this issue Oct 10, 2023 · 0 comments
Labels
ci Continuous integration documentation Improvements or additions to documentation

Comments

@alexdewar
Copy link
Collaborator

I think this task is optional. It might be worth doing if it's easy.

If we write the user guide in Markdown format, then hopefully we should be able to include it into the mkdocs-based workflow we're using to generate the developer documentation.
@alexdewar alexdewar added documentation Improvements or additions to documentation ci Continuous integration labels Oct 10, 2023
@alexdewar alexdewar mentioned this issue Oct 10, 2023
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
ci Continuous integration documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alexdewar