Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add native support for cross-referencing rules and rule attributes #252

Open
armandomontanez opened this issue Sep 12, 2024 · 0 comments
Open

Comments

@armandomontanez
Copy link

While building out a set of rules, I've been mentioning various rules and rule attributes in doc strings, and wasn't able to find any portable way to do cross referencing between generated docs. Since I've been exporting to markdown, I've been solving this via [foo](#bar_rule-foo) entries to cross-reference anchors on the same page. Unfortunately, this syntax is not inherently portable to other doc generation schemes, so if I regenerate the docs to a new format (which I'd like to do eventually) there's no guarantee that the links will continue to work.

It would be really great if stardoc could be extended to natively support expressing cross-references in document generation in a portable way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant