Skip to content

The way the various documentation websites are generated is not documented #16214

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

Open
julienrf opened this issue Oct 19, 2022 · 0 comments
Open
Assignees
Labels
area:documentation itype:meta Issues about process/similar

Comments

@julienrf
Copy link
Contributor

julienrf commented Oct 19, 2022

I think there is a general lack of clarity about how the various docs are generated.

As far as I understand, we have:

Correct me if I am wrong, and please document those things here (in CONTRIBUTING.md?), and explain the policies regarding what goes into what branch (if I want to fix something in the documentation, should I target main or language-reference-stable?).

Last, make sure the release procedure takes all those forms of documentation into account (currently, it seems only the API documentation is updated during the release process, but you should also merge the content of the main branch to language-reference-stable before the release)

Originally posted by @julienrf in #16201 (comment)

To add to the original issue, I would like to mention that a GitHub action failed after we merged a contribution (#16202) to language-reference-stable, and we don’t understand the purpose of this action. I believe better documentation would help us deal with such kind of issues in the future.

@julienrf julienrf added area:documentation itype:meta Issues about process/similar labels Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation itype:meta Issues about process/similar
Projects
None yet
Development

No branches or pull requests

2 participants