Skip to content

Publish ceramic-sdk docs #686

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

Closed
nathanielc opened this issue Mar 19, 2025 · 2 comments · Fixed by ceramicnetwork/docs-docusaurus#112
Closed

Publish ceramic-sdk docs #686

nathanielc opened this issue Mar 19, 2025 · 2 comments · Fixed by ceramicnetwork/docs-docusaurus#112
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@nathanielc
Copy link
Contributor

nathanielc commented Mar 19, 2025

We need to publish the ceramic-sdk docs. There are two sources of the docs, some guide docs that were written and the autogenerated sdk docs in sdk/docs. The guides are a bit out of date, however the tests and docs closely track so we should be able to update the docs from the tests easily.

See ceramicnetwork/docs-docusaurus#111 for the current state of the guide docs

DOD:

  • Publish ceramicnetwork docs site hosts the ceramic-sdk docs
    • Guides update and published
    • References docs published (the docs in the repo are always up-to-date enforced via CI)
    • Reference docs about the pipeline tables
    • Reference docs about the available SQL methods
  • Doc explain that ceramic-one is the only supported ceramic deployment method
  • Old composedb and js-ceramic docs are remove or otherwise hidden.
@nathanielc
Copy link
Contributor Author

Reference docs for the pipeline tables and available sql methods #691

@stbrody stbrody added the documentation Improvements or additions to documentation label Apr 9, 2025
@dav1do
Copy link
Collaborator

dav1do commented Apr 11, 2025

@smrz2001 and I worked on the docusaurus docs a bit.. he did way more that me and is gracious enough to push this one over the line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants