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

Polish docs; Automatically publish docs in CI #29

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Conversation

humpydonkey
Copy link
Collaborator

Changes

  1. Automatically publish docs in CI;
  2. Polish docs;

Notes:

  1. Add or rename a module requires updating the docs under docs/api.
  2. docs/index.md needs to be in-sync with README.md (as it is copied from it). Need to find a better way to avoid copying it.
  3. Renamed the old doc, i.e. docs/index.md to docs/old.md`. We can later re-purpose it to a user guide.

@humpydonkey humpydonkey merged commit c866bed into main Mar 26, 2024
4 checks passed
@humpydonkey humpydonkey deleted the polish-docs branch March 26, 2024 22:45
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

Successfully merging this pull request may close these issues.

2 participants