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

Closed
Tracked by #349
alexdewar opened this issue Oct 10, 2023 · 2 comments · Fixed by #679
Closed
Tracked by #349

Include user guide on GitHub Pages #346

alexdewar opened this issue Oct 10, 2023 · 2 comments · Fixed by #679
Assignees
@dalonsoa
Labels
ci Continuous integration documentation Improvements or additions to documentation should_have Things that should be included in the project

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
Closed
6 tasks
@alexdewar alexdewar added the should_have Things that should be included in the project label Oct 11, 2024
@dalonsoa dalonsoa self-assigned this Oct 29, 2024
@dalonsoa
Copy link
Contributor

If the user guide already written or it needs to be written? If it is the second, this is no small task!

@alexdewar
Copy link
Collaborator Author

alexdewar commented Oct 31, 2024 •
edited
Loading

There's a placeholder file there. @Sahil590 worked on the integration with the main program. So this is issue is just a case of publishing that file along with the other documentation.

Writing it is a separate issue: #350

Edit: It was Callum who wrote it. Sorry Sahil!

@dalonsoa dalonsoa mentioned this issue Oct 31, 2024
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dalonsoa dalonsoa

Labels
ci Continuous integration documentation Improvements or additions to documentation should_have Things that should be included in the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

📝 Add user guide file to docs ImperialCollegeLondon/FROG
2 participants
@dalonsoa @alexdewar