various doc updates in prep for 0.23

[kradalby]

Updates #2090

Summary by CodeRabbit

• Documentation
  • Enhanced comments in the configuration file to clarify database options and guide users.
  • Updated FAQ to encourage users to submit feature requests instead of pull requests.
  • Streamlined contribution guidelines by directing users to the CONTRIBUTING.md file for detailed information.
  • Simplified instructions for running the Headscale container, focusing on essential steps and removing redundant content.
  • Removed the "Glossary" entry from the navigation structure, affecting access to glossary content.

[coderabbitai]

Walkthrough

The recent changes include updates to documentation files and configuration examples. Enhancements focus on clarifying database options, modifying contribution guidelines, and streamlining instructions for running the Headscale container. These adjustments improve user understanding and simplify the documentation without altering any existing functionality or public entity declarations.

Changes

Files	Change Summary
config-example.yaml	Added comments to clarify database configuration options, emphasising the discouraged use of Postgres.
docs/faq.md	Changed phrasing from "please send us a PR" to "please post a feature request about it."
docs/index.md	Removed contribution model details; directed readers to CONTRIBUTING.md for full guidelines.
docs/running-headscale-container.md	Restructured instructions for configuring the Headscale server, removing unnecessary steps and examples.
mkdocs.yml	Removed entry for "Glossary" from the navigation section.

Poem

🐇 In the garden of code, we hop with glee,
Changes made, as clear as can be.
With comments and guides, we pave the way,
For contributions bright, come join and play!
A streamlined path, for all to explore,
In the world of Headscale, there’s always more! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fffd9d7 and 82c5aa9.

Files selected for processing (4)

• config-example.yaml (2 hunks)
• docs/faq.md (1 hunks)
• docs/index.md (1 hunks)
• docs/running-headscale-container.md (2 hunks)

Files skipped from review due to trivial changes (3)

• config-example.yaml
• docs/index.md
• docs/running-headscale-container.md

Additional context used

LanguageTool

docs/faq.md

[style] ~34-~34: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...know. We might be working on it. If you want to help, please post an feature request ab...

(REP_WANT_TO_VB)

---

[misspelling] ~34-~34: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...on it. If you want to help, please post an feature request about it. Please be aw...

(EN_A_VS_AN)

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 82c5aa9 and cd22edd.

Files selected for processing (1)

• docs/faq.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• docs/faq.md

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cd22edd and 244b3d4.

Files selected for processing (2)

• config-example.yaml (2 hunks)
• mkdocs.yml (1 hunks)

Files skipped from review due to trivial changes (1)

• mkdocs.yml

Files skipped from review as they are similar to previous changes (1)

• config-example.yaml