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

Improve docs design #113

Open
1 task
cmelone opened this issue Oct 2, 2024 · 0 comments
Open
1 task

Improve docs design #113

cmelone opened this issue Oct 2, 2024 · 0 comments
Assignees
Labels
docs Improvements or additions to documentation low-priority

Comments

@cmelone
Copy link
Collaborator

cmelone commented Oct 2, 2024

Problem/Opportunity Statement

The docs work well, but within Github they're sort of hard to navigate and don't have the best aesthetics.

What would success / a fix look like?

In the model of spackbot, use something like Jekyll/Hugo/sphinx to deploy a site.

links for inspiration:
https://github.com/spack/spackbot/tree/main/docs
https://flux-framework.readthedocs.io/en/latest/index.html
https://converged-computing.org/rainbow/#/algorithms

additions to docs:

  • add local k8s deployment instructions

@alecbcs do you happen to have the logo you drafted up a while back?

@cmelone cmelone added docs Improvements or additions to documentation low-priority labels Oct 2, 2024
@cmelone cmelone self-assigned this Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation low-priority
Projects
None yet
Development

No branches or pull requests

1 participant