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

DOC: Build documentation pages #55

Open
tangkong opened this issue Jul 16, 2024 · 0 comments
Open

DOC: Build documentation pages #55

tangkong opened this issue Jul 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@tangkong
Copy link
Contributor

Current Behavior

We have a job that publishes docs to the gh-pages branch but nothing there

Expected Behavior

We should have actual documentation

Context / environment

I remembered that his exists, set up gh to look at the branch, and now it exists but is empty 😢

Steps to Reproduce (for bugs)

N/A

Suggested Solution

Write documentation. Probably should include

  • A concise explanation of our data model (which might be unintuitive to some)
  • API documentation (autogenerated)
  • (eventually) GUI walkthroughs
@tangkong tangkong added this to the Beta Release milestone Jul 18, 2024
@tangkong tangkong added the documentation Improvements or additions to documentation label Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant