40 Commits

Author SHA1 Message Date
Markus Adrario
6eca11c42e
correct "an user" (#2687) 2025-06-03 10:00:20 +03:00
c0ffeeca7
4c0902db8b
General Style Guide: add section about Markdown (#2667) 2025-05-14 17:47:18 +01:00
c0ffeeca7
b39b7da6f9
Move general style guide to its own page (#2647) 2025-04-22 20:10:30 +02:00
c0ffeeca7
a71c68de89
Standard: style tweaks (#2635) 2025-04-09 13:34:37 +02:00
c0ffeeca7
f11987a265
Documentation examples: fix link to quality scale (#2601) 2025-03-19 10:39:25 +00:00
c0ffeeca7
0eb93417d2
about integration docs: improve page (#2582)
* about integration docs: improve page

- add screenshots showing the configuration variables blocks
- add image titles
- style tweaks

* Fix typo

* Fix title

* Specify installation
2025-02-27 10:58:22 +01:00
c0ffeeca7
8589e39d33
Add documentation about creating integration documentation (#2541)
* Add documentation about creating integration documentation

- showcases some documentation features such as glossary entries, My links, collapsible text, and reuse elements
- shows the documentation structure
- shows the example text from the integration quality scale

* Add section on reuse

* code fence to fix build error

* Remove links that no longer work after code fencing the rest of the text

* Rephrase

* Code fence elements to fix build

* Fix link

* Video: improve intro para

* Fix links

* Fix more links..

* Improve structure

- example text: add titles
- configuration section: add screenshots

* Structure list: add link to example text sections

* Attempt to fix build

* Attempt to fix build

* Fix list

* Fix header

* Revert heading level change

* remove example text and refer to template instead

* Update intro

* Update docs/documenting/lorem-ipsum.md

* Rename file name from lorem-ipsum to integration-docs-examples
2025-02-20 22:11:34 +01:00
Brant Knudson
a026788585
Fix invalid yaml (#2546) 2025-02-03 12:10:20 +00:00
William Poetra Yoga
4cafa2053d
Use italics for emphasis (#2498) 2024-12-16 21:48:37 +01:00
Bram Kragten
8757dcb948
Update YAML style guide to new syntax (#2350) 2024-10-02 14:53:55 +02:00
Stuart Holland
bd26070247
Fix link markup error in standards.md (#2303) 2024-09-03 13:17:10 +03:00
Franck Nijhof
20c58b1128
Rename Services to Service actions in more places (#2250) 2024-07-16 12:30:23 +02:00
Franck Nijhof
8eeaf3af91
Rename Services to Service actions (#2249)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-07-16 12:05:05 +02:00
Tom Brien
f3b9c78185
Update Docusaurus to v3 (#1995) 2024-06-08 10:38:41 +02:00
c0ffeeca7
17e838240b
Documentation standard: add examples (#2194) 2024-05-23 10:38:24 +02:00
c0ffeeca7
ce87985970
Documenting: apply sentence-style capitalization to headings (#2184)
- to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization)
2024-05-23 09:59:57 +02:00
c0ffeeca7
5cf2edf301
File header description: fix typo (#2153) 2024-04-24 09:51:15 +02:00
c0ffeeca7
211bd87b71
Create page: add related topics section (#2149)
* Create page: add related topics section

- as defined in https://github.com/home-assistant/home-assistant.io/pull/32372
- add usage example

* Add info that title is optional

* Update docs/documenting/create-page.md

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2024-04-23 14:22:50 +02:00
Sven Serlier
da60ee6f6a
Update URLs (#1745) 2023-04-12 23:21:46 +02:00
Franck Nijhof
84c607f5cb
Process Terminology Tooltips feedback (#1711) 2023-03-13 10:19:39 +01:00
Franck Nijhof
0cbe0d9605
Add documentation for Terminology Tooltips (#1710) 2023-03-11 17:40:40 +01:00
Roeland Van Lembergen
38bf7ffdfb
Fix folded keep operator in yaml-style-guide.md (#1525)
Where the keep operator is mentioned, it wrongly shows the folded strip operator instead of the folded keep operator.
2022-11-24 15:48:27 +01:00
Synaptic149
460318137c
Rewording of a sentence in standards.md (#1487) 2022-10-09 14:40:14 +02:00
Sven Serlier
9e8c060b2c
Components to integrations (#1348) 2022-05-30 11:48:14 +02:00
Chris
209bbe8f1f
Adding missing configuration block types and link information. (#1087) 2022-01-24 14:00:34 +01:00
Jonathan Keljo
a0a2a6dcf6
Fix a typo in documenting/standards (#1181) 2022-01-08 12:10:58 +01:00
Teemu R
a0e2666bc1
Improve platform/integration doc writing standards (#1101)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2022-01-06 21:36:02 +01:00
Alexander Leisentritt
56cc376a22
Fix section name (#1148) 2021-12-04 13:15:15 +01:00
Tom Brien
f635aad186
Change documentation style guide to favour Oxford Comma (#1086) 2021-10-15 02:12:21 +02:00
Ville Skyttä
34b425ec13
Spelling and grammar fixes (#909) 2021-04-30 08:01:54 +02:00
Franck Nijhof
8a4cb33493
Add YAML Style Guide (#802)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Tom Brien <TomBrien@users.noreply.github.com>
2021-02-11 15:50:43 +01:00
Franck Nijhof
f71271b944
Fix use of incorrect variable type (#781) 2021-01-26 11:19:02 +01:00
Matheson Steplock
72e0345ea6
Change documentation from frontmatter redirects to redirects file (#667) 2020-10-05 02:05:29 +02:00
Franck Nijhof
e91f287837
Document 'any' variable type for configuration documentation (#641) 2020-09-10 20:46:20 +02:00
Fredrik Wendt
7bc13988c4
trivial fix (#602) 2020-07-14 10:49:12 +02:00
seanvictory
7d7c53164c
Include italics (#548) 2020-05-21 13:12:02 -07:00
Franck Nijhof
698139469a
Fix bunch of links (#545) 2020-05-19 09:56:08 +02:00
Jeff Rescignano
58d0bc2744
Update the create page URL on the standards page (#535) 2020-05-17 15:29:52 +02:00
Franck Nijhof
08884e2cca
Collection of fixes and improvements (#516) 2020-05-11 08:12:01 -07:00
Franck Nijhof
d4dde03f79
Move documenting and extract add-ons (#511) 2020-05-11 11:33:35 +02:00