[docs] Trim README "What is Augur?" section#3720
Open
devs6186 wants to merge 1 commit intochaoss:mainfrom
Open
[docs] Trim README "What is Augur?" section#3720devs6186 wants to merge 1 commit intochaoss:mainfrom
devs6186 wants to merge 1 commit intochaoss:mainfrom
Conversation
…docs link The section was duplicating content that already lives in readthedocs. Replaced it with a 2-sentence summary and a pointer to the full docs. Fixes chaoss#3703 Signed-off-by: devs6186 <devyanshsomvanshi@gmail.com>
MoralCode
added
the
stale
MoralCode
requested changes
Feb 24, 2026
Contributor
MoralCode
left a comment
MoralCode
left a comment
There was a problem hiding this comment.
Overall happy with this content
| metrics are implementations of the metrics defined by our awesome community. You can find a full list of them [here](https://chaoss.community/metrics/). | ||
|
|
||
| For more information on [how to get involved on the CHAOSS website](https://chaoss.community/participate/). | ||
| Augur is a software suite for collecting and measuring structured data about free and open-source software (FOSS) communities. It gathers data from Git logs, GitHub, and other sources, normalizes it into a shared data model, and exposes health and sustainability metrics via a REST API. For a full overview, see the [Augur documentation](https://oss-augur.readthedocs.io/en/main/). |
Contributor
There was a problem hiding this comment.
I would like to see this linking to the "What is augur"/about augur" page one it is moved to the correct place. But overall im happy with the content change
Contributor
|
I have assigned this to @nancywrites. What this needs to merge:
|
MoralCode
added
waiting
MoralCode
requested changes
Feb 28, 2026
Contributor
MoralCode
left a comment
MoralCode
left a comment
There was a problem hiding this comment.
Overall happy with this content. Just waiting to link it to the dedicated What is augur ReadTheDocs page
Contributor
|
oops, didnt mean to resubmit that |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changeset
Notes
The section was duplicating content that already lives in the readthedocs "what is augur" page which was recently updated. The README is already quite long, so trimming this down makes it easier to find the actually important quick-start info. The link keeps the detailed version accessible.
Related issues/PRs
Description
This PR fixes #3703
Notes for Reviewers
Simple content change — just removes duplicate prose and points to the canonical docs page.
Signed commits