Provide infrastructure for 3rd party driver docs
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
I'm not sure what this would look like or how it would be possible, but as a 3rd party library author it would be great to be able to take advantage of the RethinkDB official docs.
A few options:
- Copy the docs manually and change the code samples
- Make it possible to maintain just the code samples, and keep the official documentation guides
Relates to #665, https://github.com/apa512/clj-rethinkdb/issues/49
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 by reading the related issue #665 and clj-rethinkdb issue #49, then compare the two proposed approaches in this issue: copying the docs or maintaining only alternate code samples. Done should be an agreed, documented mechanism for third-party driver authors to reuse the official guides and maintain their own samples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100