rethinkdb / rethinkdb/docs

Add links to github file to all docs (not just API docs)

Open
#153 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement system
Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

And make them pretty icons (instead of a bar like in the API docs)!

Also, API docs should show links to edit doc entries that don't have their own page.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing edit-link bar in the API documentation and the templates or styles used by the other documentation pages. Check how API entries without their own page are rendered; done means all documentation pages show the requested icon links and those API entries expose edit links too.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
design, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.