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

Make a static site for this project #262

Open
cmungall opened this issue Mar 3, 2022 · 0 comments
Open

Make a static site for this project #262

cmungall opened this issue Mar 3, 2022 · 0 comments

Comments

@cmungall
Copy link
Contributor

cmungall commented Mar 3, 2022

If you like I can have @hrshdhgd do this using either sphinx or mkdocs (I would do mkdocs with a material theme)

However, there may be a preferred way of making docs for scala projects that exposes the scala API

The first pass would be just to break the README into a couple of pages:

  • about.md
  • install.md
  • running.md

then we can add more docs for different workflows etc

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

No branches or pull requests

1 participant