Skip to content

Navigation Menu

Appearance settings

View all features
- BY COMPANY SIZE
  Enterprises
  Small and medium teams
  Startups
  Nonprofits
- BY USE CASE
  App Modernization
  DevSecOps
  DevOps
  CI/CD
  View all use cases
- BY INDUSTRY
  Healthcare
  Financial services
  Manufacturing
  Government
  View all industries
View all solutions
- EXPLORE BY TOPIC
  AI
  Software Development
  DevOps
  Security
  View all topics
- EXPLORE BY TYPE
  Customer stories
  Events & webinars
  Ebooks & reports
  Business insights
  GitHub Skills
- SUPPORT & SERVICES
  Documentation
  Customer support
  Community forum
  Trust center
  Partners
- COMMUNITY
  GitHub SponsorsFund open source developers
- PROGRAMS
  Security Lab
  Maintainer Community
  Accelerator
  Archive Program
- REPOSITORIES
  Topics
  Trending
  Collections
- ENTERPRISE SOLUTIONS
  Enterprise platformAI-powered developer platform
- AVAILABLE ADD-ONS
  GitHub Advanced SecurityEnterprise-grade security features
  Copilot for BusinessEnterprise-grade AI features
  Premium SupportEnterprise-grade 24/7 support
Pricing

Search code, repositories, users, issues, pull requests...

Search

Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation.

Appearance settings

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Dismiss alert

guardian / recommendations Public

Notifications You must be signed in to change notification settings
Fork 5
Star 71

Code
Issues 4
Pull requests 7
Actions
Security
Insights

Additional navigation options

Code
Issues
Pull requests
Actions
Security
Insights

Repo documentation guidance#192

Open

SHession wants to merge 18 commits intomainguardian/recommendations:mainfrom

add-repo-documentation-guidanceguardian/recommendations:add-repo-documentation-guidanceCopy head branch name to clipboard

Conversation Commits18 (18)Checks Files changed

Open

Repo documentation guidance#192
SHession wants to merge 18 commits intomainfrom
add-repo-documentation-guidance

Commits

Commits on Jan 20, 2026

Initial draft on repo documentation guidance
SHession
committed
Adds initial README template to the documentation
SHession
committed
Update repo-documentation.md

SHession
and
tjsilver
authored
Update repo-documentation.md

SHession
and
tjsilver
authored
Update repo-documentation.md

SHession
and
tjsilver
authored
Update repo-documentation.md

SHession
and
tjsilver
authored

Commits on Jan 26, 2026

Update repo-documentation.md

SHession
and
NovemberTang
authored
Removes google tech-writing query params
SHession
committed
Add a recommendaiton to define your audience in repo documentation
SHession
committed
Adds detail about markdown features to repo documentation doc
SHession
committed

Commits on Jan 28, 2026

Update repo-documentation.md

SHession
and
emdash-ie
authored
Fix rogue > in repo documentation
SHession
committed
Includes why writing for an audience is valuable in repo documentation
SHession
committed
Update repo-documentation.md

SHession
and
emdash-ie
authored

Commits on Feb 5, 2026

Add reference to Mermaid diagrams in documentation illustration guidance
SHession
committed
Renames repo-documentation -> documentation
SHession
committed
Improve markdown template top-level description advice
SHession
committed
Improve README template introduction advice
SHession
committed

Footer

© 2026 GitHub, Inc.

Footer navigation

Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.