Skip to content

Fix CONTRIBUTING headings#41

Merged
leandro-lucarella-frequenz merged 2 commits intofrequenz-floss:v0.x.xfrom
llucax:contributing-heading
Nov 4, 2022
Merged

Fix CONTRIBUTING headings#41
leandro-lucarella-frequenz merged 2 commits intofrequenz-floss:v0.x.xfrom
llucax:contributing-heading

Conversation

@leandro-lucarella-frequenz
Copy link
Contributor

  • Fix heading of CONTRIBUTING.md
  • mkdocs: Watch for README and CONTRIBUTING files

All sections were using headings with level 1, which is not included in
the ToC of the generated docs.

We also use a syntax that makes it easier to see which level of heading
we are using.

Signed-off-by: Leandro Lucarella <leandro.lucarella@frequenz.com>
When using `mkdocs serve`, now if any of those files changes, the docs
will be regenerated automatically.

Signed-off-by: Leandro Lucarella <leandro.lucarella@frequenz.com>
@leandro-lucarella-frequenz leandro-lucarella-frequenz requested a review from a team as a code owner November 4, 2022 12:07
@leandro-lucarella-frequenz leandro-lucarella-frequenz added this to the v0.11.0 milestone Nov 4, 2022
@leandro-lucarella-frequenz leandro-lucarella-frequenz added part:docs Affects the documentation part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users labels Nov 4, 2022
@github-actions github-actions bot removed the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Nov 4, 2022
@leandro-lucarella-frequenz leandro-lucarella-frequenz merged commit 7778405 into frequenz-floss:v0.x.x Nov 4, 2022
@leandro-lucarella-frequenz leandro-lucarella-frequenz deleted the contributing-heading branch November 4, 2022 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants