-
Notifications
You must be signed in to change notification settings - Fork 46
docs: Rework the documentation #451
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
Draft
Kriskras99
wants to merge
1
commit into
main
Choose a base branch
from
feat/documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains hidden or 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
dc07230 to
b1f461c
Compare
martin-g
reviewed
Feb 2, 2026
b1f461c to
5a99fa2
Compare
[The first page of our documentation](https://docs.rs/apache-avro/0.21.0/apache_avro/) was overwhelmingly large. This commit moves the documentation to several places: - The introduction to Avro itself was moved to `documentation::primer` - Using the crate the "Avro" way was moved to `documentation::generic` - I've also changed the focus to the fact that it allows for more dynamic code - Using the crate the "Serde" way was moved to `serde` - Calculating schema fingerprints was moved to `Schema::fingerprint` - Users can easily find it by searching for fingerprint - Custom name validators was moved to `validator` - Can be found via search and listed under the modules on the first page - Custom schema equality was moved to `schema_equality` - Can be found via search and listed under the modules on the first page It also removes some sections - How to install the library and enable features, this is basic Rust knowledge - Section about breaking changes in minor versions, this is to be expected as the crate is at `0.*` - Reading and writing logical types, this was a very large section but not very useful - Ill formed data, instead the error message was improved by adding a link to the function to change the limit In addition, I've enabled some Clippy lints related to documentation and fixed all the lints it caused. Future work: - Enable the `clippy.missing_errors_doc` and `clippy.missing_panics_doc` lints - Deprecate some types that live in the root namespace - For example, the codec related types. Instead the `codec` module should be public - This will further improve the signal to noise ratio on the first page
5a99fa2 to
0410a97
Compare
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.
TODO:
The first page of our documentation was overwhelmingly large. This commit moves the documentation to several places:
documentation::primerdocumentation::genericserdeSchema::fingerprintvalidatorschema_equality0.*This also adds documentation for the
AvroSchemaderive (on the trait) and updates the derive crate documentation to link to it.In addition, I've enabled some Clippy lints related to documentation and fixed all the lints it caused.
Future work:
clippy.missing_errors_docandclippy.missing_panics_doclintscodecmodule should be public