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

Investigate migrating documentation to Stardoc #763

Open
jayconrod opened this issue Apr 17, 2020 · 2 comments
Open

Investigate migrating documentation to Stardoc #763

jayconrod opened this issue Apr 17, 2020 · 2 comments

Comments

@jayconrod
Copy link
Contributor

Stardoc is a documentation generator for Bazel rules, providers, and other definitions.

Currently, Gazelle documentation is maintained separately from the implementation, so it's easy for it to drift.

We should investigate whether Stardoc is a viable replacement for the current documentation. If it is, we should migrate the current documentation to generated Stardoc.

Analogous rules_go issue bazel-contrib/rules_go#762.

@alexeagle
Copy link
Contributor

@achew22 now that we've committed to having some markdown in the repository, for documentation that's output by stardoc, what do you think about having a mix of rst and markdown in the long-term? Or should I also run the remaining docs through something like pandoc to translate them to markdown as well so there's only one markup language? IMO we should do the latter.

@achew22
Copy link
Member

achew22 commented Nov 2, 2021

I think that's a great idea. Let's leave this issue open to group all the work that needs to be done, but I appreciate all the work. Thank you!

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

No branches or pull requests

3 participants