README Anywhere (BB-3616)

Atlassian Tutorials avatarAtlassian Tutorials created an issue

User asked for this README enhancement on the doc page:

I thought, it would apply to any readme file, not only the one at root.

Currently it seems to show everywhere only the readme from root, regardless presence of any readme file in current directory.

Proposal for enhancement: Show content of readme as now, just start searching from currently listed directory and traverse up untill some readme is found.

This will allow to show independent directory descriptions.

jan.vlcinsky@gmail.com

I am logging the enhancement here for tracking.

Comments (2)

  1. Markus Mottl

    I second this suggestion. Some large projects with many sub-projects won't do with just one top-level README. It would be great if the current README in a subdirectory could be rendered, too, when browsing the source, or the closest one up the hierarchy if there is none.

  2. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.