Motivation
rdoc-markdown currently renders class/module pages with lib/templates/classfile.md.erb and emits index.csv directly from generator code. There is no canonical gem-level landing page/template where documentation-set metadata can live.
That leaves gem-wide signals, such as whether type information is available for the generated docs, without a natural home.
Proposal
Introduce a gem-level/index template that owns top-level documentation metadata and can also become the rendering path for index.csv or its replacement metadata.
The template could expose documentation-set attributes such as:
- generated title
- generated pages/classes summary
- whether type signatures are available
- links to generated class/module pages
- search/index metadata currently emitted as
index.csv
Notes
This should not change existing generated class/module page behavior initially. The first step can be a small additive template that gives gem-level concerns a canonical location instead of spreading them through class page templates or generator internals.
Motivation
rdoc-markdowncurrently renders class/module pages withlib/templates/classfile.md.erband emitsindex.csvdirectly from generator code. There is no canonical gem-level landing page/template where documentation-set metadata can live.That leaves gem-wide signals, such as whether type information is available for the generated docs, without a natural home.
Proposal
Introduce a gem-level/index template that owns top-level documentation metadata and can also become the rendering path for
index.csvor its replacement metadata.The template could expose documentation-set attributes such as:
index.csvNotes
This should not change existing generated class/module page behavior initially. The first step can be a small additive template that gives gem-level concerns a canonical location instead of spreading them through class page templates or generator internals.