How to get tabs in my project readme section

[dvaldivia]

Select Topic Area

Question

Body

I'm seeing some projects that have some new tabs like https://github.com/google/cadvisor

[fury-05]

You need to have all required documents files like

- MyRepository
  - README.md
  - LICENSE
  - CODE_OF_CONDUCT.md
  - docs
    - installation.md
    - usage.md

once you have all you will see option to show it in tabs

Organize these files in your GitHub repository:

README:

The README file is the default landing page for your repository.
Create a file named README.md in the root of your repository. Use Markdown syntax to format the content.
GitHub will automatically display the content of the README file on the main page of your repository.

LICENSE:

To add a license to your repository, create a file named LICENSE in the root directory.
There are several types of open-source licenses to choose from. You can generate a license file using services like ChooseALicense.com.
GitHub will recognize the license file, and the license information will be visible on your repository page.

CODE_OF_CONDUCT:

If you want to include a code of conduct in your repository, create a file named CODE_OF_CONDUCT.md in the root directory.
You can use a template from nor create your own. GitHub will recognize this file, and it will be linked from your repository.

Other Custom Tabs:

If you want to create additional tabs like "Documentation," "Changelog," or anything else, organize your content into directories and create Markdown files.

For example, you might create a folder named docs and place files like installation.md and usage.md inside. GitHub will automatically create a "Docs" tab.

Remember to commit and push these files to your GitHub repository.

After doing so, GitHub will recognize these special files and display the corresponding tabs on the repository page.

Hope this is what you were looking for.

[bia1708]

I've just tested the creation of a "Docs" tab for a repository and it didn't work. My repository file structure was as such:

- My repository
  - docs/
    - another_readme.md
  - README.md 

Only the README.md file shows up in the tabs (or any files titled SECURITY.md, CODE_OF_CONDUCT.md or LICENSE files). I've also not been able to find any documentation on these custom tabs. Where did you get this information from?

[shupershuff]

I've also had no luck trying this suggestion.

[RockyMM]

Hey guys,

These are called "default community health files" and are apparently placed inside

• The root of the repository
• The .github folder
• The docs folder

or inside special .github repo of your organization.

Take a look at SO response here. Also some documentation here.

The list is always changing, and this is the current extract from the documentation:

Community health file	Description
CODE_OF_CONDUCT.md	A CODE_OF_CONDUCT file defines standards for how to engage in a community.
CONTRIBUTING.md	A CONTRIBUTING file communicates how people should contribute to your project.
Discussion category forms	Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository.
FUNDING.yml	A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project.
GOVERNANCE.md	A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made.
Issue and pull request templates and config.yml	Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository.
SECURITY.md	A SECURITY file gives instructions on how to report a security vulnerability in your project and description that hyperlinks the file.
SUPPORT.md	A SUPPORT file lets people know about ways to get help with your project.

[kasir-barati]

Why license cannot be inside .github 😕, when I moved LICENSE inside .github it was removed from the tabs 🤔.

[qwloh]

Perhaps it has to do with the fact that LICENSE is supposed to go alongside your code whenever it is distributed (say, installed as library), while things in .github are often considered dev artifact and are not shipped?

[andyw8]

These don't necessarily correspond to tabs though, e.g. on https://github.com/Shopify/ruby-lsp we have a CONTRIBUTING.md but there is no tab showing.

[RockyMM]

Hey, I guess you are right. It seems that these "tab" thingies are not very well documented by GitHub.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[ultimaweapon]

It will be great if GitHub supports custom tabs here.

[sidney-eliot]

At the very least, @github should add a tab for the "CONTRIBUTING.md"