FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

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

/ version-checker Public

New documentation structure - #375

Merged
davidcollom merged 4 commits into
mainfrom
update-doc
May 1, 2025
ConversationCommits (4)ChecksFiles changed
Merged

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

Conversation

maria-reynoso commented Apr 30, 2025 •
edited
Loading

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.

maria-reynoso requested a review from joshw123 April 30, 2025 15:41
davidcollom requested changes May 1, 2025
View reviewed changes

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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
Update docs/installation.md
7d99f7e 
Co-authored-by: David Collom <david.collom@jetstack.io>
Update docs/installation.md
9efabe8 
Co-authored-by: David Collom <david.collom@jetstack.io>
update readme
4d26fff
maria-reynoso requested a review from davidcollom May 1, 2025 08:51
davidcollom merged commit 2ab5c71 into main May 1, 2025
davidcollom deleted the update-doc branch May 1, 2025 08:55
github-actions Bot mentioned this pull request Jun 3, 2025
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

davidcollom davidcollom approved these changes
joshw123 Awaiting requested review from joshw123

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL