apache / apache/avro-rs

Improve documentation layout

Open Beginner friendly
#645 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
130
Forks
62
Avg merge
11h
Merged PRs (30d)
45

Description

There is a whole list of re-exports polluting the main documentation page (https://docs.rs/apache-avro/0.22.0/apache_avro/). They should use `#[doc(inline)]` and the deprecated functions should be removed.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the public re-exports that produce the main docs.rs page at https://docs.rs/apache-avro/0.22.0/apache_avro/. Use #[doc(inline)] for the relevant re-exports and identify the deprecated functions for removal; the work is done when the generated page no longer has the listed re-export clutter or deprecated functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.