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

fix: Integrate docs with docusaurus #45

Merged
merged 19 commits into from
Oct 19, 2023
Merged

fix: Integrate docs with docusaurus #45

merged 19 commits into from
Oct 19, 2023

Conversation

nakul1010
Copy link
Contributor

@nakul1010 nakul1010 commented Oct 16, 2023 •
edited
Loading

Pull Request Tasks

  • Integrate TypeScript documentation with Docusaurus.
  • Add documentation for the electrs methods.
  • Currently, the automated documentation can be found at http://localhost:3000/docs/api/. Integrate it with the navbar for easy access.
  • ReVerify the example are correct by running them.

@nakul1010 nakul1010 self-assigned this Oct 16, 2023
@vercel
Copy link

vercel bot commented Oct 16, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bob ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 19, 2023 11:09am

@nakul1010 nakul1010 changed the title fix: Integrate docs with docusaurus fix(wip): Integrate docs with docusaurus Oct 18, 2023
@nakul1010 nakul1010 changed the title fix(wip): Integrate docs with docusaurus fix: Integrate docs with docusaurus Oct 18, 2023
@gregdhill
Copy link
Contributor

Looks good! Before we merge I would like to change the main API page to not show the repo README and if possible the sidebar should not show the other options for "Learn", "Build" and "drafts".

nud3l
nud3l requested changes Oct 19, 2023
View reviewed changes
Copy link
Contributor

@nud3l nud3l left a comment

Choose a reason for hiding this comment

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

I like the way the API is documented. There are some issues with the organization of the docs though that needs addressing.

docs/docusaurus.config.js Outdated Show resolved Hide resolved
docs/docusaurus.config.js Outdated Show resolved Hide resolved
docs/docusaurus.config.js Outdated Show resolved Hide resolved
sdk/src/electrs.ts Show resolved Hide resolved
docs/docusaurus.config.js Outdated Show resolved Hide resolved
@nakul1010 nakul1010 mentioned this pull request Oct 19, 2023
Closed
@nud3l nud3l merged commit 4c1386e into master Oct 19, 2023
2 checks passed
@nud3l nud3l deleted the nakul/fix_docs branch October 19, 2023 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nud3l nud3l nud3l approved these changes

@gregdhill gregdhill Awaiting requested review from gregdhill

Assignees

@nakul1010 nakul1010

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nakul1010 @gregdhill @nud3l