Add documentation fields and generate READMEs #9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mellowagain
approved these changes
Feb 14, 2023
base64uuid/Cargo.toml
Outdated
| @@ -1,6 +1,8 @@ | |||
| [package] | |||
| name = "base64uuid" | |||
| description = "Type for representing base64url-encoded UUIDs" | |||
| documentation = "https://docs.rs/base64uuid/latest/base64uuid/" | |||
There was a problem hiding this comment.
we dont need this as docs.rs replaces this with the actual docs.rs url on publishing to crates.io
fiberplane-models/Cargo.toml
Outdated
| @@ -1,6 +1,8 @@ | |||
| [package] | |||
| name = "fiberplane-models" | |||
| description = "Core models used across Fiberplane" | |||
| documentation = "https://docs.rs/fiberplane-models/latest/fiberplane-models/" | |||
| @@ -1,6 +1,8 @@ | |||
| [package] | |||
| name = "fiberplane-provider-runtime" | |||
| description = "Wasmer runtime for Fiberplane Providers" | |||
| documentation = "https://docs.rs/fiberplane-provider-runtime/latest/fiberplane-provider-runtime/" | |||
There was a problem hiding this comment.
again, i think u get it now so ill stop
emschwartz
approved these changes
Feb 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds
documentationandreadmefields to all the published crates. Also puts the bulk of the crate READMEs inside of the crate'ssrc/lib.rs, so that it will also be displayed prominently ondocs.rs. I added some READMEs where they were still missing, and fixed some links in the process.Only crate exempted for now is the API client, because the generator has no method yet to generate the given fields, or to include a README as the directory gets wiped every time (@mellowagain).
Fixes FP-2997
Checklist
Please make sure all of these are checked before merging. Please leave items
you think are non-applicable in the list, but use strike-through (
~~) toindicate they don't apply.
[ ] The changes have been tested to be backwards compatible.[ ] The OpenAPI schema and generated client have been updated.[ ] PR for API is ready and reviewed: (please link)[ ] PR for Studio is ready and reviewed: (please link)[ ] PR for CLI is ready and reviewed: (please link)[ ] PR for Proxy is ready and reviewed: (please link)[ ] The CHANGELOG(s) are updated.When adding new
fiberplane-modelsmodule:[ ] PR for fp-openapi-rust-gen is ready and reviewed: (please link)When adding new operation types:
[ ] PR for fiberplane-ot is ready and reviewed: (please link)After merging, please merge related PRs ASAP, so others don't get blocked.