`examples/` directory missing after documentation restructure?
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- rust
- Domain
- documentation
Research direction
Start at assert-struct/src/lib.rs around line 850 and follow the referenced ../../examples/ path. Compare it with the existing assert-struct/examples directory and check the rendered link on docs.rs. Done means the documentation points to the intended examples location and accurately describes the available examples.
Written by the indexing model from the issue text.
Description
There are few locations where an examples/ directory is mentioned, but I noticed this one in particular as a broken link on docs.rs (positioned immediately after lots of really clear, illustrative examples):
See the [examples directory](../../examples/) for comprehensive real-world examples including:
There is an examples directory (in a different location), but it only includes a single, simple example.
(I was excited to see more – this is a cool crate!)
- Dominant language
- Rust
- Stars
- 86
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gitbutlerapp/gitbutler#15998 · 1 comment ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100