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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #87

Closed
wants to merge 12 commits into from
Closed

Improve documentation #87

wants to merge 12 commits into from

Conversation

akaIDIOT
Copy link
Member

@akaIDIOT akaIDIOT commented Mar 11, 2022 •
edited
Loading

  • add a comprehensive list of examples easy → complex
  • add and fill a glossary for all the terms used by confidence
  • explain the use of references
  • explain the do's and don'ts of sequences
  • add the full default load order
  • include the changelog

@akaIDIOT akaIDIOT marked this pull request as draft March 11, 2022 15:26
@akaIDIOT akaIDIOT changed the title Draft: Improve documentation Improve documentation Mar 11, 2022
@akaIDIOT akaIDIOT force-pushed the documentation/rationale-design branch from f4c1f04 to 502ab1b Compare September 8, 2022 09:28
@akaIDIOT
Copy link
Member Author

akaIDIOT commented Dec 9, 2024

The more I use it, the more I kinda hate sphinx and restructured text; would mkdocs have earned a retry? 🤔

@akaIDIOT
Copy link
Member Author

Mkdocs has apparently come a way since I last fought it, seems a lot more usable now. Content in here should be ported to #116.

akaIDIOT added a commit that referenced this pull request Jan 31, 2025
@akaIDIOT
Port introduction from #87 into index.md
98ad3ab
akaIDIOT added a commit that referenced this pull request Jan 31, 2025
@akaIDIOT
Add loading a single file from #87
e2811a0
akaIDIOT added a commit that referenced this pull request Jan 31, 2025
@akaIDIOT
Add "Reading from multiple files" from #87
543bbc4
akaIDIOT added a commit that referenced this pull request Jan 31, 2025
@akaIDIOT
Add "Overriding defaults from one file to the next" from #87
026c9a1
@akaIDIOT
Copy link
Member Author

Done, let's add and discuss this further in #116 🙏

@akaIDIOT akaIDIOT closed this Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@akaIDIOT