Skip to content

feat(Website): add website directory with Docusaurus generated doc site. #3

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
Merged
merged 19 commits into from
Jun 16, 2022
Merged

feat(Website): add website directory with Docusaurus generated doc site. #3

merged 19 commits into from
Jun 16, 2022
+26,909 −9,105

Conversation

jeff1010322
Copy link
Member

@jeff1010322 jeff1010322 commented Apr 6, 2022 •
edited
Loading

Description

  • Created website directory with Docusaurus generated template
  • Removed docs versioning, put all generated docs in the docs folder
  • Added OpenAPI Spec for API Reference
  • Added Redocusaurus plugin to display Redoc generated pages for API Reference based on OAS
  • Cleaned up duplicate API docs and definitions, added in-line Redoc components to display OAS definitions
  • Update documentation to latest v0.8.1 version of Mazzaroth

@jeff1010322
fix(api): fix channel_info_lookup filename
54f4e63
@jeff1010322
feat(definitions): updated definitions to match latest versions
2fb6ea3
@jeff1010322
fix(definitons): Add Data definition
d5b471a
@jeff1010322
feat(API): updated and consolidated API documentation, removed outdat…
65246b8 
…ed definitions
@jeff1010322
cleanup(Tools): removed Websocket docs, updated Tools to pull m8 doc …
7a21e23 
…and remove cli and it
@jeff1010322
feat(v0.8.0): updated architecture, tutorial, and examples to v0.8.0
a366e78 
Removed references to outdated objects such as Channel Config, and Accounts.
Updated examples to use m8 tool.
Updated configs to reference latest config such as default port number.
@jeff1010322
fix(api): remove duplicate definition on transaction submit response
32d5e21
@jeff1010322
fix(api): fix newline markdown spacing
d5f24f9
@jeff1010322
fix(definitions): fix Data definition header
1f27a9a
@jeff1010322
cleanup(versioning): remove versioning, store all processed docs in d…
d6aa6d7 
…ocs directory, remove API Reference
@jeff1010322
feat(website): generate Docusaurus site to display docs, add OpenAPI …

Verified

This commit was signed with the committer’s verified signature.
davidtwco David Wood
GPG key ID: 01760B4F9F53F154
Verified
Learn about vigilant mode
b9e12eb 
…Spec to work with Redoc component
@jeff1010322
feat(definitions): remove definitions, used React import of Redoc com…
2e42799 
…ponent from Open API Spec instead
@jeff1010322
fix(config): use a number scrollYOffset value
f46b8a7
@jeff1010322
cleanup(README): update README to use npm

Verified

This commit was signed with the committer’s verified signature. The key has expired.
jonhoo Jon Gjengset
GPG key ID: D64AC9D67176DC71
Expired
Verified
Learn about vigilant mode
21b6d69
@jeff1010322
Merge branch 'main' into website
b2afc9c
@jeff1010322
fix(deps): bump redocusaurus version to fix api page sidebar scrollin…
9f68802 
…g issue
@jeff1010322
feat(docs): upate docs for mazzaroth v0.8.1 using updated Gateway nam…
6a3e1f6 
…ing and config values
@jeff1010322
fix(config): update config for deployment, check-in package-lock
9be84e1
@jeff1010322 jeff1010322 requested a review from elewis787 April 6, 2022 16:56
@jeff1010322 jeff1010322 merged commit fbfae8c into main Jun 16, 2022
@jeff1010322 jeff1010322 deleted the website branch June 16, 2022 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elewis787 elewis787

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@jeff1010322 @elewis787