AusClimateService / AusClimateService/axiom

Link to GitHub repo from docs and vice versa

Open
#145 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
3
Forks
3
PR merge metrics
No merged PRs in 30d

Description

There is no link to the docs on the front page of the repo (README or Description) that I could find.

There is also no link back to the repository in the docs. This is a major problem as axiom is a *very* well used term, and a simple google search did not return this repo in the top hits.

Would also be good for the Description to have a short description of the purpose of the repository.

Contributor guide

Open the contributing guide

Research direction

Start with the repository README and GitHub Description, then locate the documentation entry point mentioned in the issue. Add reciprocal links between the repository and docs, and give the repository Description a short purpose statement; done means users can navigate in both directions and identify the project from its listing.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.