Add article about updating documentation

[annavik]

Preview:

Summary by CodeRabbit

• Documentation
  • Added a new contribution guide explaining how to create and update docs, submit changes, and format articles.
  • Reworked homepage intro with a clearer "note" stating docs are a work in progress, plus updated contribution and issue links and a pointer to the dev guide.
  • Converted a generic note to a labeled "Warning" in the processing-data section for clarity.
  • Updated site title and navigation casing.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The pull request updates documentation structure and configuration by adding a new contribution guide, reformatting admonitions for consistency, updating site metadata, and revising introductory content with links to newly created documentation resources.

Changes

Cohort / File(s)	Summary
Documentation Index docs/index.md	Replaces inline disclaimer with proper note admonition directive; updates introductory text to reference new dev-guide contribution resource; updates issue link to antenna-docs site
New Contribution Guide docs/sections/dev-guide/update-documentation.md	Adds new documentation page detailing repository location, account setup, article structure, categories, markdown reference, and step-by-step instructions for creating and updating documentation articles
Admonition Format Update docs/sections/user-guide/processing-data.md	Changes admonition type from generic note to danger warning with updated label for improved visual distinction
Site Configuration mkdocs.yml	Updates site name casing from "Antenna Platform Documentation" to "Antenna documentation"; changes nav section label from "User Guide" to "User guide"; adds entry for new sections/dev-guide/update-documentation.md page under Developer Guide

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Verify markdown formatting and admonition syntax consistency across updated files
• Confirm new contribution guide instructions are accurate and complete
• Check mkdocs.yml navigation entries and file paths for correctness

Poem

🐰 A doc update hops in with care,
New guides to help contributors share,
Disclaimers dressed in admonition style,
Warnings shine bright—configuration all the while! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: adding a new documentation article about updating documentation, which is the primary addition across all modified files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/add-update-docs-article

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb1d9aa and c7951aa.

📒 Files selected for processing (4)

• docs/index.md (1 hunks)
• docs/sections/dev-guide/update-documentation.md (1 hunks)
• docs/sections/user-guide/processing-data.md (1 hunks)
• mkdocs.yml (2 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/sections/dev-guide/update-documentation.md

[grammar] ~3-~3: Ensure spelling is correct
Context: ...te articles. All contributions are much appriciated! Articles are written in [Markdown](https...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

---

[style] ~6-~6: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 1242 characters long)
Context: ...des articles for Antenna contributors. !!! tip "Tip" Do you need a quick refe...

(EN_EXCESSIVE_EXCLAMATION)

🔇 Additional comments (8)

docs/sections/user-guide/processing-data.md (1)

3-5: Semantic improvement: elevates warning emphasis.

Changing the admonition from a generic note to a danger warning appropriately emphasizes the development status and recommends team support. This improves user experience and clarity.

docs/sections/dev-guide/update-documentation.md (4)

5-6: Clear article structure explanation.

The description of article categories (User Guide for users, Developer Guide for contributors) and Markdown format is clear and helpful.

---

7-9: Helpful tip with relevant reference.

The Markdown Cheat Sheet link is a useful resource for contributors and appropriately placed as a tip.

---

11-17: Clear workflow for adding articles.

The step-by-step instructions are complete and actionable. References to GitHub folders and mkdocs.yml configuration are accurate and helpful.

Verify that the GitHub links to user-guide and dev-guide folders are correct and accessible.

---

19-23: Simplified and appropriate workflow for updates.

The workflow for updating existing articles correctly omits the mkdocs.yml step, which is only needed for new articles. Instructions are clear and consistent with the "Add a new article" section.

mkdocs.yml (2)

1-1: Cleaner site name.

The simplified site name "Antenna documentation" improves clarity and is more concise.

---

4-4: Navigation updates are consistent and properly integrated.

The case changes ("User guide" and "Developer guide") improve stylistic consistency. The new entry for sections/dev-guide/update-documentation.md correctly references the new contribution guide file added in this PR.

Also applies to: 14-14, 16-16

docs/index.md (1)

3-7: Improved documentation entry with better guidance.

Using an admonition block improves visual hierarchy over a plain text disclaimer. The addition of contribution guidance with a link to the new update-documentation guide encourages community participation.

Verify that both links resolve correctly:

• Internal link: sections/dev-guide/update-documentation should point to the new article
• External link: GitHub issue link should point to the antenna-docs repository issues

You can test the internal link by checking the generated site or reviewing the mkdocs.yml configuration to ensure the path matches.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/sections/dev-guide/update-documentation.md (1)

3-3: Minor style consideration: exclamation mark usage.

The file contains exclamation marks in lines 3 and 9. While this conveys enthusiasm and friendliness, be mindful that overuse of exclamation marks can impact professional tone. The current usage is acceptable, but if other documentation follows a more measured style, consider aligning for consistency.

Also applies to: 9-9

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c7951aa and 8171f8f.

📒 Files selected for processing (1)

• docs/sections/dev-guide/update-documentation.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/sections/dev-guide/update-documentation.md

[style] ~6-~6: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 1242 characters long)
Context: ...des articles for Antenna contributors. !!! tip "Tip" Do you need a quick refe...

(EN_EXCESSIVE_EXCLAMATION)

🔇 Additional comments (1)

docs/sections/dev-guide/update-documentation.md (1)

1-23: Documentation structure and content look good.

The file provides clear, well-organized guidance on how to contribute updates to the documentation. The instructions are specific with direct GitHub links, making it easy for contributors to follow the workflow. The admonition tips and reference links add helpful context.