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(autonomi): refactor documentation for API #2490

Merged
merged 9 commits into from
Dec 6, 2024

Conversation

b-zee
Copy link
Contributor

@b-zee b-zee commented Dec 4, 2024

  • Remove data feature, as it is the basic feature needed for the API to function.
  • Add top-level crate example docs.
  • Move Python and WASM documentation to their own READMEs.
  • Annotate feature-gated items so it's clear in the documentation a certain feature has to be enabled to use (e.g. fs).
  • Some renames and exposing modifications.

autonomi/src/python.rs Dismissed Show dismissed Hide dismissed
@b-zee b-zee force-pushed the docs-autonomi-rustdoc-add branch from 893d301 to 0c28379 Compare December 4, 2024 15:21
@b-zee b-zee changed the title docs(autonomi): add archive_get rustdoc example docs(autonomi): refactor documentation for API Dec 4, 2024
@b-zee b-zee marked this pull request as ready for review December 4, 2024 15:47
@b-zee b-zee enabled auto-merge December 4, 2024 15:48
@b-zee b-zee added this pull request to the merge queue Dec 6, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 6, 2024
@b-zee b-zee added this pull request to the merge queue Dec 6, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 6, 2024
@b-zee b-zee added this pull request to the merge queue Dec 6, 2024
@jacderida jacderida removed this pull request from the merge queue due to a manual request Dec 6, 2024
@jacderida jacderida merged commit cedab29 into maidsafe:main Dec 6, 2024
27 checks passed
@b-zee b-zee deleted the docs-autonomi-rustdoc-add branch December 6, 2024 12:46
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.

3 participants