carols10cents / carols10cents/rust-conversion-reference
Use rustdoc instead, somehow, so the code only exists in one place
- Dominant language
- HTML
- Stars
- 40
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
It's getting tedious getting the code and tests working in the main.rs file and then copy-pasting them to the index.html file. I haven't used rustdoc yet, but I know it can execute code examples as tests that the docs are right... I don't know how easy it is to customize the output into this table format, though.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by comparing the examples and tests in main.rs with the generated content in index.html. Research rustdoc's executable documentation examples and whether its output can support the existing table format. Done means the code and tests have one source of truth without losing the current index.html presentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100