Skip to content

Adding repodiving.md to inbound section of OSPO-guide - #134

Merged
isaac-rtc merged 3 commits into
mainfrom
DSACMS/isaac/repo-diving-md
Jul 28, 2026
Merged

Adding repodiving.md to inbound section of OSPO-guide#134
isaac-rtc merged 3 commits into
mainfrom
DSACMS/isaac/repo-diving-md

Conversation

@isaac-rtc

Copy link
Copy Markdown
Contributor

Problem

The OSPO Guide did not contain onboarding documentation for the repodive-tools toolkit, requiring users to rely on the standalone repository README to understand the available scripts, required dependencies, and usage workflows. The existing documentation also lacked additional context around how the tools fit together, their prerequisites, and supporting repository analysis techniques.

Solution

  • Added a new Repo Diving Guide under the inbound section of the OSPO Guide.
  • Ported and expanded the existing documentation from the repodive-tools repository into a structured onboarding guide.
  • Added overview, prerequisites, usage, and notes sections for each available repodive script.
  • Documented required dependencies (git, curl, jq, scc, and gource) with installation links and brief explanations of each tool.
  • Added guidance for generating contributor reports and Gource logs, including the relationship between the generated artifacts and their intended use.
  • Added navigation for the new Repo Diving Guide within the OSPO Guide inbound section.
  • Clarified that the Gource workflow targets a configured GitHub organization and uses a GitHub Personal Access Token rather than a GitHub Enterprise Personal Access Token, matching the current implementation.

Result

Contributors now have a centralized onboarding resource within the OSPO Guide that explains the purpose of each repodive script, required setup, supporting dependencies, and common repository analysis workflows without needing to rely solely on the repodive-tools README.

Test Plan

  • Built the OSPO Guide locally and verified the new page renders correctly.
  • Verified the new page appears in the inbound navigation.
  • Tested the repodive scripts to confirm the documented prerequisites and usage accurately reflect the current implementation.
  • Verified all internal and external documentation links resolve correctly.

@isaac-rtc isaac-rtc added the documentation Improvements or additions to documentation label Jul 28, 2026
@isaac-rtc isaac-rtc linked an issue Jul 28, 2026 that may be closed by this pull request

@decause-gov decause-gov left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work here @isaac-rtc

If the documentation on repodive-tools itself does not reflect these changes, we should also update the docs over there to include this improved documentation. Nice job!

@isaac-rtc

Copy link
Copy Markdown
Contributor Author

Great work here @isaac-rtc

If the documentation on repodive-tools itself does not reflect these changes, we should also update the docs over there to include this improved documentation. Nice job!

Thanks @decause-gov !

I'll merge this and then work on updating docs on the repodice-tools itself, I'll add you as reviewer once done!

@isaac-rtc
isaac-rtc merged commit 2966ac9 into main Jul 28, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

create repodiving.md

2 participants