thoughtbot / thoughtbot/factory_bot
Zeal/Dash docset
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 8.2k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Zeal (and also Dash) provides a beautiful UI to documentation. The documentation is locally stored, available without an Internet connection. Let's get in on that.
The docset guide explains how to generate these files from various sources. Since factory_bot is both YARD and also mdBook, we'll need to investigate what will be most useful to the end user. Simple HTML might be easiest.
Contributor guide
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 with the linked Zeal/Dash docset guide and compare the existing YARD and mdBook documentation sources. Determine which source and packaging approach is most useful for offline users, then generate and verify a working docset. The issue names no project files or tests, so the implementation entry point will need to be located first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100