chore: stop ignoring inline doc stubs (.*.md)

[michaelassraf]

What

Removes the .*.md rule from .gitignore and replaces it with a loud comment telling future contributors not to re-add it.

Why

#212 added:

# Generated per-file doc stubs (external doc-orchestrator bot). All documentation
# lives in docs/; these hidden .md files next to source must not be committed.
.*.md

Two problems with that:

1. The inline doc stubs are supposed to be committed. They're per-file documentation written next to the source they describe, generated by the Flamingo AI Technical Writer. They belong in the repo and in the PR diff, reviewed alongside the code. Ignoring them silently discards the output of every documentation run.

2. It hard-failed the whole workflow. .*.md also matched the orchestrator's own run status file, so the job died at branch creation, before a single doc was generated:

📝 Creating PR branch early for progressive commits...
Switched to a new branch 'docs/flamingo-ai-technical-writer-1785077147640'
The following paths are ignored by one of your .gitignore files:
.flamingo-ai-technical-writer-status.md
hint: Use -f if you really want to add them.
Error: Process completed with exit code 1.

See run #30206764288.

Reviewer notes

• No files change state in this PR — the ignored stubs were never committed, so there is nothing to un-ignore retroactively. The next documentation run will bring them in.
• Companion fix in the hub, so the status file can never be blocked by a target repo's ignore rules again: flamingo-stack/multi-platform-hub#953.
• If the inline stubs are ever genuinely unwanted, that's a generator-side setting — not something to silence with an ignore rule.

Summary by CodeRabbit

• Chores
  • Updated repository file handling so hidden Markdown documentation files are preserved and tracked.
  • Clarified guidance for maintaining inline documentation files alongside related source files.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: dbe8936d-c44d-4392-b601-13d9eedc18b5

📥 Commits

Reviewing files that changed from the base of the PR and between b5eade1 and 7a94708.

📒 Files selected for processing (1)

• .gitignore

---

📝 Walkthrough

Walkthrough

Updates .gitignore so hidden .*.md documentation stubs are no longer ignored, while documenting the orchestrator status-file issue that prompted reverting the previous rule.

Changes

Documentation tracking

Layer / File(s)	Summary
Allow hidden Markdown stubs .gitignore	Removes the .*.md ignore rule and clarifies that hidden Markdown documentation stubs should be committed and kept synchronized with adjacent source files.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: oleg-flamingocx

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: removing the .*.md ignore rule so inline documentation stubs are committed.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/commit-inline-doc-stubs

---

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.}