datafusion-contrib / datafusion-contrib/datafusion-distributed
Ensure the project is good for docs.rs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 139
- Forks
- 67
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 35
Description
We should make sure that this project has a good documentation page in docs.rs, right now we have this:
https://docs.rs/datafusion-distributed/latest/datafusion_distributed/index.html
I think we are missing something other things, like a better landing page, and probably a bit of better structure overall.
Another topic is formatting inside docstrings, for examples, should we be using backticks for every referenced symbol?
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.
Research direction
Start by reviewing the current docs.rs page at https://docs.rs/datafusion-distributed/latest/datafusion_distributed/index.html and the project's Rust docstrings. Identify the missing landing-page content, structure improvements, and formatting guidance for referenced symbols; done means these documentation gaps and conventions are clearly addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100