Include GitHub links in docs

Open Beginner friendly
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
github
Domain
documentation

Research direction

Locate the examples documentation used to build the GitHub Page and read its current structure. Add links to the example repositories at the top, then preview or build the documentation and verify that the links appear and work.

Written by the indexing model from the issue text.

Description

documentation good first issue

The examples documentation on the GitHub Page should include a link to the repositories themselves at the top so people can explore the code while they're reading the documentation

Dominant language
Python
Stars
0
Forks
3
PR merge metrics
No merged PRs in 30d

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.

More from ML4GW/pinto

All issues in ML4GW/pinto

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.