Extend docs

[spoorcc]

Summary by CodeRabbit

• Documentation
  • Added example manifest section with sample YAML configuration demonstrating remotes, projects, and attributes
  • Included reference links to real-world project implementations

[coderabbitai]

Walkthrough

README.md and doc/vendoring.rst updated with documentation examples. README.md adds a new "Example manifest" section containing a YAML manifest structure demonstration. doc/vendoring.rst adds two new real-world project references (Example Yocto and Example Zephyr).

Changes

Cohort / File(s)	Summary
Documentation Examples README.md	Added new "Example manifest" section with YAML manifest example demonstrating remotes, projects, and various attributes structure.
Real World Projects doc/vendoring.rst	Added two new example project links (Example Yocto and Example Zephyr) to the "Real world projects using Dfetch" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Cleanup documentation and make it more readable #907: Directly modifies doc/vendoring.rst to add example project links in the same "Real world projects" section.
• Fix #891 - Update docs #892: Updates manifest schema and documentation for manifest-related content and examples.

Suggested labels

documentation

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Extend docs' is vague and generic, using a non-descriptive term that doesn't convey specific information about which documentation was extended or what content was added.	Consider using a more specific title like 'Add manifest example and project links to docs' to clearly indicate the specific documentation additions made in this changeset.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch extend-docs

---

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

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 73-76: The README example uses an unsupported top-level
"manifest:" key; update the YAML snippet so "version", "remotes", and "projects"
are top-level entries (remove the "manifest:" wrapper) to match the schema
expected by dfetch/manifest/manifest.py (which requires version, remotes,
projects at top level), and ensure all subsequent indented blocks (remotes and
projects entries like the github/sourceforge entries and project blocks such as
cpputest-git-tag and tortoise-svn-branch-rev) are re-indented as shown in the
suggested doc fix.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c83e018a-2951-4936-9e64-c097bdf97d6b

📥 Commits

Reviewing files that changed from the base of the PR and between 44290f0 and 4911aea.

📒 Files selected for processing (2)

• README.md
• doc/vendoring.rst