Skip to content

Commit abbb9b5

Browse files
authored
Merge pull request #169 from FutureProofHomes/v0.2.0-documentation
V0.2.0 documentation
2 parents 7971608 + 47445a8 commit abbb9b5

34 files changed

Lines changed: 1832 additions & 377 deletions

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,35 @@ Don't forget to give the project a star! Thanks again!
9696

9797
<p align="right">(<a href="#readme-top">back to top</a>)</p>
9898

99+
## Stable / Beta Documentation
100+
101+
Some pages have content that differs between the **Stable** and **Beta** firmware. We use [content tabs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/) to let viewers toggle between the two. Because `content.tabs.link` is enabled, selecting "Stable" or "Beta" on any page syncs the choice across the entire site.
102+
103+
### Writing version-specific content
104+
105+
For sections that differ between firmware versions, wrap them in content tabs:
106+
107+
```markdown
108+
=== "Stable"
109+
110+
Stable-specific content here...
111+
112+
=== "Beta"
113+
114+
Beta-specific content here...
115+
```
116+
117+
Pages where content is identical across versions should **not** use tabs.
118+
119+
### Graduating beta to stable
120+
121+
When a beta version ships as stable:
122+
123+
1. Replace the "Stable" tab content with the "Beta" tab content.
124+
2. Remove the tab wrappers (or start a new "Beta" tab for the next cycle).
125+
3. Search for any remaining `=== "Beta"` / `=== "Stable"` blocks across all docs to ensure nothing is missed.
126+
127+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
99128

100129
<!-- LICENSE -->
101130
## License

docs/assets/MA_DSP_settings.png

5.58 KB
Loading
363 KB
Loading
974 KB
Loading
1.07 MB
Loading
36.6 KB
Loading
41.8 KB
Loading
8.36 MB
Loading
477 KB
Loading
921 KB
Loading

0 commit comments

Comments
 (0)