pebble-dev / pebble-dev/developer.rebble.io
Clarify how to contribute, on the website itself
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
Hi, I just opened https://github.com/pebble-dev/developer.rebble.io/pull/82 but it took me a moment to figure out how to contribute to the docs / where the repo was.
How about some kind of visible link to this repo somewhere on the site?
I have a very simple experiment here: https://github.com/mortenfyhn/developer.rebble.io/tree/github-link. It adds a GitHub link to the sidebar:
and
The wide sidebar variant makes the sidebar slightly wider than before, which is not ideal. In any case, I'm happy to hack some variant of this and open a PR.
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 reviewing the github-link experiment and its sidebar changes in the linked repository branch. Compare the narrow and wide sidebar variants, then verify the site presents a visible link to the developer.rebble.io GitHub repository without an unsuitable sidebar width change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, web-dev
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100