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

Add basic documentation and auto-publish to GitHub Pages #36

Closed
alexdewar opened this issue May 22, 2024 · 3 comments · Fixed by #47
Closed

Add basic documentation and auto-publish to GitHub Pages #36

alexdewar opened this issue May 22, 2024 · 3 comments · Fixed by #47
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@alexdewar
Copy link
Collaborator

In addition to API documentation (#15), we also want long-form documentation, including tutorials etc. as we do for MUSE v1.

There are lots of choices in terms of tools, but I think the two obvious ones are:

  • Sphinx -- which we're already using for MUSE v1 and uses the RST format for files
  • Jekyll -- the standard tool used for GitHub pages which uses the markdown format

@ahawkes do you have any preferences?

@dalonsoa any ideas?

@alexdewar alexdewar added the enhancement New feature or request label May 22, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in MUSE May 22, 2024
@alexdewar alexdewar self-assigned this May 22, 2024
@alexdewar alexdewar moved this from 📋 Backlog to 🔖 Ready in MUSE May 22, 2024
@alexdewar alexdewar added the question Further information is requested label May 22, 2024
@dalonsoa
Copy link
Collaborator

dalonsoa commented May 22, 2024

There's a rust specific option, mdBook: https://rust-lang.github.io/mdBook/index.html . There's even an GH action to deploy it to GitHub Pages automatically. This would diverge from what MUSE v1 uses, but might be the right call. I've no idea how well this integrates with the API documentation created via rustdoc.

On the other hand, rustdoc also work on plain Markdown files, so maybe that is all we need...?

@ahawkes
Copy link
Contributor

ahawkes commented May 22, 2024

I don't know the pros and cons here, so fine with me if you decide the best route.

@alexdewar
Copy link
Collaborator Author

mdBook looks good. That's got my vote! If no one has strong feelings, then we can just do it with that.

@alexdewar alexdewar moved this from 🔖 Ready to 🏗 In progress in MUSE Jun 3, 2024
alexdewar added a commit that referenced this issue Jun 5, 2024
@dalonsoa dalonsoa moved this from 🏗 In progress to 👀 In review in MUSE Jun 5, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in MUSE Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants