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

docs: set up docsaurus for API reference docs and add content #113

Merged
merged 5 commits into from
Jun 1, 2022

Conversation

PdoubleU
Copy link
Collaborator

@PdoubleU PdoubleU commented May 26, 2022

  1. Upgrade docsaurus from 2.0.0-beta.14 to 2.0.0-beta.16:
    - new version fixes a bug regarding to items type (docsaurus.config.js), here more comments on that:
    fix(theme-classic): add docSidebar as allowed item in dropdown facebook/docusaurus#6599
  2. Add sidebars for: intro and api
    • move intro and associated folders into 'intro'
    • add 'api' folder and types and api files inside it
  3. Set up sidebars for intro (as Documentation) and api (as API Reference)

Closes: #112

1. Upgrade docsaurus from 2.0.0-beta.14 to 2.0.0-beta.16:
       - new version fixes a bug regarding to items type (docsaurus.config.js), here more comments on that:
       facebook/docusaurus#6599
2. Add sidebars for: intro and api
      - move intro and associated folders into 'intro'
      - add 'api' folder and types and api files inside it
3. Set up sidebars for intro (as Documentation) and api (as API Reference)
@PdoubleU PdoubleU changed the title docs: set up docsaurus for API reference docs docs: set up docsaurus for API reference docs and add content May 26, 2022
Add api reference content
Add type content
@PdoubleU PdoubleU marked this pull request as ready for review May 27, 2022 11:53
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/apiReference.md Outdated Show resolved Hide resolved
docs/docs/api/types.md Outdated Show resolved Hide resolved
docs/docs/api/types.md Outdated Show resolved Hide resolved
@danielmark0116 danielmark0116 merged commit bdcc371 into master Jun 1, 2022
@danielmark0116 danielmark0116 deleted the pw/add_api_reference_in_docs branch June 1, 2022 18:23
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.

[DOCS]: add api reference
2 participants