New issue
Advanced search Search tips

Issue 654599 link

Starred by 2 users

Issue metadata

Status: Untriaged
Owner: ----
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: ----
Pri: 3
Type: Bug



Sign in to add a comment

Markdown documentation very hard to find and consume

Project Member Reported by e...@chromium.org, Oct 10 2016

Issue description

Could we please change where we host the markdown documentation files? The current situation where we rely on Gitiles doesn't really work well given the lack of discoverability and url format.

Take the layout documentation for instance, the only way to get to it is by browsing the entire source tree looking for README.md files or by the following extremely verbose URL: https://chromium.googlesource.com/chromium/src/+/master/third_party/WebKit/Source/core/layout/README.md

Could we please add some better way to browser, get to and link to our markdown files. As it is we have a lot of very valuable information there but no good way to consume it.

The urls are long enough that we can't even link to it from the code without violating the line-length limit and trying to remember how to get to a file or communicate the URL in person or over the phone is a non-starter.

Something like docs.chromium.org listing all .md files with sane urls would be great. Another option would be to stop using markdown all together and instead use a format like txt or html so that the files can be accessed directly from the file system. 

 

Sign in to add a comment