Dvc.org: web: flag to disable title case (capitalization of slugs) in nav sidebar

Created on 4 Jan 2019  路  3Comments  路  Source: iterative/dvc.org

UPDATE: For the latest issue description see https://github.com/iterative/dvc.org/issues/150#issuecomment-464556333 below.

Currently we have some kind of auto-generation, but we use manual approach instead https://github.com/iterative/dvc.org/pull/149#discussion_r245409688 . Need to consider improving our engine to auto-parse files in a specified directory and extract headers from them to use as labels.

doc-engine enhancement feature-request good first issue help wanted priority-p2 website

All 3 comments

labels are already optional. You should provide them only if need to override it. It titleizes them by default (e.g. gc becomes Gc), that's why we have to provide a huge list for command references. I think we can make a flag to remove titleization. Or turn if off.

As for files - I would keep it as is. It's important to be able to specify the order of sections and exclude certain sections. I think explicitly managing the contents is the best option here.

Any thoughts @efiop ?

Sure, that is reasonable. Let's leave it as is. Closing.

I'll keep it open to add a flag to turn off titleization. So, that we can remove at least a list of labels for command references and a few other sections.

Was this page helpful?
0 / 5 - 0 ratings