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

Modernize documentation #654

Merged
merged 3 commits into from
Aug 1, 2023
Merged

Modernize documentation #654

merged 3 commits into from
Aug 1, 2023

Conversation

dmtrek14
Copy link
Collaborator

This PR contains 3 commits that each address a piece of modernizing the documentation for this application.

  1. Existing .rst files are converted to .md
  2. Documentation is updated with information about new API and frontend
  3. mdBook support is added, including a Github action to publish documentation to Github pages.

As part of these commits, any unnecessary or deprecated files were removed.

- Convert to md
- Update links to point to md files
- Remove .rst files
- Remove .dia files 
- Remove unnecessary files
- Update md formatting in some places
- Add book.toml to hold settings for book
- Restructure docs folder for mdBook
- Remove `help` section from Makefile
- Update references to docs location
- Add github action to publish docs to gh pages
Copy link
Member

@anarute anarute left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great, thank you!

@dmtrek14 dmtrek14 merged commit 2246276 into main Aug 1, 2023
2 checks passed
@dmtrek14 dmtrek14 deleted the convert-docs-md branch August 1, 2023 14:37
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