feat(ui): tabbed view for root markdown files alongside README #500

Closed
opened 2026-06-06 11:21:21 +00:00 by jmiller · 1 comment
Owner

Summary

Add tabs above the README rendering on the repository home page for important root-level markdown files, similar to how GitHub displays them. Instead of only showing the README, provide clickable tabs for files like:

  • README.md
  • LICENSE / LICENSE.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • SECURITY.md
  • CHANGELOG.md

Motivation

GitHub surfaces these files as tabs on the repo landing page, making them easy to discover without browsing the file tree. This improves contributor onboarding and project transparency.

Proposed Behavior

  1. On the repo home page, detect well-known markdown files in the repository root
  2. Display a tab bar above the rendered content (README is the default active tab)
  3. Clicking a tab renders that file inline, replacing the README content area
  4. Only show tabs for files that actually exist in the repo
  5. README tab should always be first if it exists

References

  • GitHub shows LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY as tabs on repo home pages

Authored by Jonathan Miller (@jmiller)

## Summary Add tabs above the README rendering on the repository home page for important root-level markdown files, similar to how GitHub displays them. Instead of only showing the README, provide clickable tabs for files like: - README.md - LICENSE / LICENSE.md - CONTRIBUTING.md - CODE_OF_CONDUCT.md - SECURITY.md - CHANGELOG.md ## Motivation GitHub surfaces these files as tabs on the repo landing page, making them easy to discover without browsing the file tree. This improves contributor onboarding and project transparency. ## Proposed Behavior 1. On the repo home page, detect well-known markdown files in the repository root 2. Display a tab bar above the rendered content (README is the default active tab) 3. Clicking a tab renders that file inline, replacing the README content area 4. Only show tabs for files that actually exist in the repo 5. README tab should always be first if it exists ## References - GitHub shows LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY as tabs on repo home pages --- *Authored by Jonathan Miller (@jmiller)*
Author
Owner

Testing Complete — All Checks Pass

Tested on dev (git.dev.mokoconsulting.tech) with testadmin/tab-test repo containing all 6 well-known files.

Test Result
All 6 tabs render (readme, license, contributing, code_of_conduct, security, changelog) PASS
License tab shows MIT License content PASS
Security tab shows Security Policy content PASS
Changelog tab shows content PASS
Readme tab active by default PASS
Contributing tab active when selected PASS

Merged to dev via PR #501.


Authored by Jonathan Miller (@jmiller)

## Testing Complete — All Checks Pass Tested on dev (git.dev.mokoconsulting.tech) with testadmin/tab-test repo containing all 6 well-known files. | Test | Result | |------|--------| | All 6 tabs render (readme, license, contributing, code_of_conduct, security, changelog) | PASS | | License tab shows MIT License content | PASS | | Security tab shows Security Policy content | PASS | | Changelog tab shows content | PASS | | Readme tab active by default | PASS | | Contributing tab active when selected | PASS | Merged to dev via PR #501. --- *Authored by Jonathan Miller (@jmiller)*
Sign in to join this conversation.