New documentation structure by maria-reynoso · Pull Request #375 · jetstack/version-checker · GitHub
Skip to content

New documentation structure#375

Merged
davidcollom merged 4 commits into
mainfrom
update-doc
May 1, 2025
Merged

New documentation structure#375
davidcollom merged 4 commits into
mainfrom
update-doc

Conversation

@maria-reynoso

@maria-reynoso maria-reynoso commented Apr 30, 2025

Copy link
Copy Markdown
Contributor
  • Adding benefits of using version-checker
  • The README.md now focuses on the core purpose and benefits of version-checker.
  • Detailed sections like Metrics, and Installation are moved to separate files for better organization.
  • Changes to specific sections (e.g., installation instructions) can be made in their respective files without modify the main README.

@davidcollom davidcollom left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I love the direction, some small suggestions and nits

Comment thread docs/installation.md Outdated
Comment thread docs/installation.md Outdated
Comment thread docs/installation.md Outdated
maria-reynoso and others added 3 commits May 1, 2025 10:49
Co-authored-by: David Collom <david.collom@jetstack.io>
Co-authored-by: David Collom <david.collom@jetstack.io>
@maria-reynoso maria-reynoso requested a review from davidcollom May 1, 2025 08:51
@davidcollom davidcollom merged commit 2ab5c71 into main May 1, 2025
@davidcollom davidcollom deleted the update-doc branch May 1, 2025 08:55
@github-actions github-actions Bot mentioned this pull request Jun 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants