bazelbuild / bazelbuild/stardoc

Crossreferences support

Open
#149 0 comments 0 reactions 0 assignees View on GitHub
P3 type: feature request
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

(As suggested by @rickeylev) Markdown has primitive support for cross-references: you can linkify a term (e.g. ``[`FooInfo`]``) and it will be linked to a named url reference FooInfo, which can be e.g. provided elsewhere on the page - perhaps automatically appended to the documentation page by Stardoc's markdown processor.

We might want to use this mechanism in the following ways:
* automatically linkifying standard starlark and build language types, globals, etc.;
* allowing a `stardoc` rule to specify a custom crosslinks.md input which will get appended to generated markdown output;
* (stretch goal) perhaps automatically linkifying refernces to other rules found in BCR?

CC @comius

Contributor guide

Open the contributing guide

Research direction

Start by locating Stardoc's Markdown processor and the code that assembles generated documentation pages. Determine how named URL references are currently handled, then define completion around automatic links for standard Starlark and build-language symbols and support for a custom crosslinks.md input; the BCR linking idea is explicitly a stretch goal.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.