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.

Sign up for GitHub

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

Jump to bottom

Update documentation #314

Merged
merged 1 commit into from
Feb 21, 2022
Merged

Update documentation #314

merged 1 commit into from
Feb 21, 2022

Conversation

afritzler
Copy link
Member

Proposed Changes

  • Regenerated API reference docs
  • Added mermaid support to mkdocs
  • Removed stale docs

@github-actions github-actions bot added size/XXL documentation Improvements or additions to documentation labels Feb 19, 2022
@afritzler
Copy link
Member Author

@adracus check out the latest dope stuff https://github.com/onmetal/onmetal-api/blob/bab48a455b84ff58627269475d09ff48fcf3d2e3/docs/README.md

Here is the official post announcing the mermaid support in GH markdown: https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/

/cc @EvgeniaOrfeeva

@afritzler afritzler added the enhancement New feature or request label Feb 19, 2022
@afritzler
Update documentation
b84c133 
- Regenerated API reference docs
- Added mermaid support to mkdocs
- Removed stale docs
@adracus adracus merged commit 050ab0a into main Feb 21, 2022
@adracus adracus deleted the docs_update branch February 21, 2022 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adracus adracus adracus approved these changes

@EvgeniaOrfeeva EvgeniaOrfeeva Awaiting requested review from EvgeniaOrfeeva

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request size/XXL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@afritzler @adracus