Skip to content

feat: overhaul README and add link checker#2578

Merged
chmouel merged 1 commit intotektoncd:mainfrom
chmouel:overhaul-doc-readme
Mar 16, 2026
Merged

feat: overhaul README and add link checker#2578
chmouel merged 1 commit intotektoncd:mainfrom
chmouel:overhaul-doc-readme

Conversation

@chmouel
Copy link
Copy Markdown
Member

@chmouel chmouel commented Mar 16, 2026 •
edited
Loading

📝 Description of the Change

This PR overhauls the project README to make it more concise and user-friendly while improving documentation navigation. Additionally, it adds a link-checking step to validate README links before running the full documentation link checker.

Changes:

  • README.md: Completely restructured from a lengthy document (381 deletions) to a concise version (58 additions) with clear sections, better navigation, and an organized "Read the docs" section that links to comprehensive documentation
  • Makefile: Added a README link validation step (3 additions) to the check-links target to ensure all links in the README remain valid

Rationale: The previous README was difficult to navigate. This overhaul makes it easier for new contributors and users to understand the project and find relevant documentation quickly.

👨🏻‍ Linked Jira

🔗 Linked GitHub Issue

Fixes #

🧪 Testing Strategy

  • Unit tests
  • Integration tests
  • End-to-end tests
  • Manual testing
  • Not Applicable

Manual testing was performed to verify:

  • README renders correctly with all links intact
  • Makefile link-checking step executes properly

🤖 AI Assistance

  • I have used AI assistance for this PR.
  • I have not used any AI assistance for this PR.

If you have used AI assistance, please provide the following details:

Which LLM was used?

  • GitHub Copilot
  • ChatGPT (OpenAI)
  • Claude (Anthropic)
  • Cursor
  • Gemini (Google)
  • Other: ____________

Extent of AI Assistance:

  • Documentation and research only
  • Unit tests or E2E tests only
  • Code generation (parts of the code)
  • Full code generation (most of the PR)
  • PR description and comments
  • Commit message(s)

Important

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer to your commit message.
For example:

Co-authored-by: Gemini gemini@google.com
Co-authored-by: ChatGPT noreply@chatgpt.com
Co-authored-by: Claude noreply@anthropic.com
Co-authored-by: Cursor noreply@cursor.com
Co-authored-by: Copilot Copilot@users.noreply.github.com

**💡You can use the script ./hack/add-llm-coauthor.sh to automatically add
these co-author trailers to your commits.

✅ Submitter Checklist

  • 📝 My commit messages are clear, informative, and follow the project's How to write a git commit message guide. The Gitlint linter ensures in CI it's properly validated
  • ✨ I have ensured my commit message prefix (e.g., `fix:`, `feat:`) matches the "Type of Change" I selected above.
  • ♽ I have run `make test` and `make lint` locally to check for and fix any issues. For an efficient workflow, I have considered installing pre-commit and running `pre-commit install` to automate these checks.
  • 📖 I have added or updated documentation for any user-facing changes.
  • 🧪 I have added sufficient unit tests for my code changes.
  • 🎁 I have added end-to-end tests where feasible. See README for more details.
  • 🔎 I have addressed any CI test flakiness or provided a clear reason to bypass it.
  • If adding a provider feature, I have filled in the following and updated the provider documentation:
    • GitHub App
    • GitHub Webhook
    • Gitea/Forgejo
    • GitLab
    • Bitbucket Cloud
    • Bitbucket Data Center

@chmouel
feat: overhaul README and add link checker
42fe00d 
Updated the README to use a concise layout with better navigation and
organized content that links to the documentation.

Added a link-checking step to the Makefile to ensure
documentation links remain valid.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
@pipelines-as-code
Copy link
Copy Markdown

pipelines-as-code bot commented Mar 16, 2026

🔍 PR Lint Feedback

Note: This automated check helps ensure your PR follows our contribution guidelines.

⚠️ Items that need attention:

🎫 Jira reference

Add a Jira reference in the description using one of the following formats:

  • https://issues.redhat.com/browse/SRVKP-<number>

If no SRVKP ticket exists yet, link a GitHub issue instead (e.g., Fixes #123).
Minor housekeeping PRs without Jira coverage can skip this after confirming with reviewers.

🤖 AI attribution

The following commits lack an explicit AI attribution footer:

  • 42fe00d feat: overhaul README and add link checker

If no AI assistance was used for a commit, you can ignore this warning.
Otherwise add an Assisted-by: or Co-authored-by: footer referencing the AI used.

ℹ️ Next Steps

  • Review and address the items above
  • Push new commits to update this PR
  • This comment will be automatically updated when issues are resolved
🔧 Admin Tools (click to expand)

Automated Issue/Ticket Creation:

  • /issue-create - Generate a GitHub issue from this PR content using AI
  • /jira-create - Create a SRVKP Jira ticket from this PR content using AI

⚠️ Important: Always review and edit generated content before finalizing tickets/issues.
The AI-generated content should be used as a starting point and may need adjustments.

These commands are available to maintainers and will post the generated content as PR comments for review.

🤖 This feedback was generated automatically by the PR CI system

@pipelines-as-code pipelines-as-code bot added ci enhancement New feature or request labels Mar 16, 2026
@chmouel chmouel merged commit bb03a79 into tektoncd:main Mar 16, 2026
3 checks passed
@chmouel chmouel deleted the overhaul-doc-readme branch March 16, 2026 23:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

ci enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@chmouel