Skip to content

Make the configuration documentation in a table. #2907

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
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kristianbenoit
Copy link

So that default is displayed, but on Windows and MacOS, there's a missing default and there are values that dont have a default ?

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Documentation get's a better format.

What is the current behavior?

The defaults are not really available in the doc and it is a bit hard to understand, plus the directories seems to be there twice.

What is the new behavior?

Documentation is now a table with default values, it should be reviewed to add a few defaults (in code) and the value for buld_cache.path on Windows an MacOS in this doc.

Does this PR introduce a breaking change, and is titled accordingly?

Other information

Sorry, this a pull request replacing #2906 . Which had errors and I fixed bypassed them by creating another pull request after the last changes.

So that default is displayed, but on Windows and MacOS, there's a
missing default and there are values that dont have a default ?
@kristianbenoit
Copy link
Author

Sorry for the second PR, I just did not know how to fix the other one (#2906 ) , but it still have mysterious errors. Possibly cause I used   to intend variable level in the table ? Other than that, I see nothing in the details.

@per1234 per1234 added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels May 3, 2025
@kristianbenoit
Copy link
Author

I should have put the variable section (board_manager, daemon, directories, ...) as part of the variable names, the table would have been easier to read and get rid of the   at the same time. Perhaps there's a way to create a table division , i.e. fat lines ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants