chore: move coding guidelines from .github to docs/

[Copilot]

• Move coding guidelines to docs/ and update references
• Add docs/ entry to tl;dr and detailed tree in copilot-instructions.md Repository Structure section

Summary by CodeRabbit

• Chores
  • Reorganized repository documentation and updated internal configuration to reference the new docs location.
• Documentation
  • Updated contributor and instruction guides to point to the relocated documentation files so links and references remain correct.

[softhack007]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1d28a384-9724-437d-8ebf-320988f00762

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• ✅ Review completed - (🔄 Check again to review again)

📝 Walkthrough

Walkthrough

This PR relocates instruction file references from .github/ to a new docs/ directory structure. Configuration files (.coderabbit.yaml and .github/copilot-instructions.md) are updated to point to the relocated C++, ESP-IDF, web, and CI-CD instruction files under docs/ instead of .github/.

Changes

Cohort / File(s)	Summary
CodeRabbit Configuration .coderabbit.yaml	Updated all path references and selectors to point from .github/*.instructions.md to docs/*.instructions.md, including C++, web, CI-CD, and ESP-IDF instruction file paths.
Copilot Instructions .github/copilot-instructions.md	Added docs/ directory to repository structure description and updated language-specific convention reference paths from top-level to docs/*.instructions.md locations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Revise copilot-instructions.md: consolidate, shorten, and extract language-specific rules, take 2 #353: Directly updates .coderabbit.yaml path selectors for instruction files from .github/ to docs/ structure.
• Revise *.instructions.md: separate AI-relevant special knowledge from background information for contributors  #354: Modifies .coderabbit.yaml review path rules and handling of *.instructions.md files with HUMAN_ONLY enforcement.
• fix: make agent-build.instructions.md visible to agent mode; fix cpp.instructions.md glob whitespace #356: Updates .github/copilot-instructions.md links and glob targets for instruction file references.

Poem

🐰 Files hop to new homes in docs/,
Configuration paths now point true,
Instruction guides find better nooks,
Organization shines through and through! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ 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 'chore: move coding guidelines from .github to docs/' clearly and concisely summarizes the main change in the PR: relocating coding guideline files from .github to docs/ and updating references.
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
• Commit unit tests in branch copilot/add-docs-folder-move-guidelines

---

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

[softhack007]

@coderabbitai this PR moves our coding guides into a new folder docs/. Please very that the changes in .coderabbit.yaml to ensure that files in the new location will be used in your reviews. .github/copilot-instructions.md stays into old location, so its mandatory to read for all AI tasks.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

Let me inspect the actual files to verify everything is correct.

---

🏁 Script executed:

#!/bin/bash
echo "=== .coderabbit.yaml ==="
cat .coderabbit.yaml

echo ""
echo "=== Contents of docs/ ==="
ls -la docs/ 2>/dev/null || echo "docs/ directory not found"

echo ""
echo "=== Contents of .github/ (instruction files) ==="
ls -la .github/*.instructions.md 2>/dev/null || echo "No *.instructions.md in .github/"
ls -la .github/copilot-instructions.md 2>/dev/null || echo ".github/copilot-instructions.md not found"

echo ""
echo "=== Check for any remaining .github references to instruction files in .coderabbit.yaml ==="
grep -n "\.github" .coderabbit.yaml || echo "No .github references found in .coderabbit.yaml"

echo ""
echo "=== Check docs/ instruction files referenced in .coderabbit.yaml ==="
grep -n "docs/" .coderabbit.yaml || echo "No docs/ references found in .coderabbit.yaml"

Length of output: 6267

---

@softhack007: Verification complete. Here's the summary:

✅ .coderabbit.yaml — all references are correct

What	Old path	New path	Status
C++ conventions	.github/cpp.instructions.md	docs/cpp.instructions.md	✅ Updated
Web UI conventions	.github/web.instructions.md	docs/web.instructions.md	✅ Updated
CI/CD conventions	.github/cicd.instructions.md	docs/cicd.instructions.md	✅ Updated
ESP-IDF guidelines	.github/esp-idf.instructions.md	docs/esp-idf.instructions.md	✅ Updated
Path selector for alignment checks	.github/*.instructions.md	docs/*.instructions.md	✅ Updated
Project overview / general rules	.github/copilot-instructions.md	.github/copilot-instructions.md	✅ Intentionally kept in old location

✅ File presence confirmed

• All 4 instruction files are present in docs/ (cpp, web, cicd, esp-idf)
• .github/copilot-instructions.md remains in .github/ as intended
• The .github/workflows/*.{yml,yaml} path selector is unaffected (correctly still points to .github/workflows/)

No stale .github/*.instructions.md references remain in .coderabbit.yaml.

⚠️ One item to confirm

.github/agent-build.instructions.md is still present in .github/ but is not referenced in .coderabbit.yaml. Was this file intentionally left behind (e.g., it's a GitHub Copilot agent instruction, not a CodeRabbit review guideline), or should it also be moved to docs/ and referenced?

---

🧠 Learnings used

Learnt from: softhack007
Repo: MoonModules/WLED-MM PR: 0
File: :0-0
Timestamp: 2026-04-04T00:29:49.113Z
Learning: In MoonModules/WLED-MM, function-level doc comment blocks (e.g. /* ***** */ style headers) are NOT required during code reviews, especially not for previously existing functions. Do not flag missing function-level comments as review issues in this repository.

---

Learnt from: softhack007
Repo: MoonModules/WLED-MM PR: 0
File: :0-0
Timestamp: 2026-04-04T14:32:02.598Z
Learning: In MoonModules/WLED-MM, clang-format is intentionally NOT enforced via CI or .clang-format config because it would cause merge conflicts when cherry-picking features from upstream WLED (which uses different formatting). Instead, "soft" formatting rules are documented in .github/cpp.instructions.md. Do not recommend adding clang-format to CI as a follow-up to missing automated enforcement — the decision is deliberate.

[softhack007]

.github/agent-build.instructions.md is still present in .github/ but is not referenced in .coderabbit.yaml. Was this file intentionally left behind ?

@coderabbitai Yes this was intentionally - the file is only meant for copilot agent tasks.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@softhack007 Understood, thanks for the clarification! .github/agent-build.instructions.md is intentionally scoped to Copilot agent tasks and doesn't need to be referenced in .coderabbit.yaml or moved to docs/. I'll remember this for future reviews.

With that confirmed, the PR looks good — all coding guideline files have been correctly relocated to docs/, all references in .coderabbit.yaml and .github/copilot-instructions.md are updated, and the intentional exceptions (.github/copilot-instructions.md and .github/agent-build.instructions.md) remain in their correct locations. ✅

---

✏️ Learnings added

Learnt from: softhack007
URL: https://github.com/MoonModules/WLED-MM/pull/358

Timestamp: 2026-04-07T16:49:44.261Z
Learning: In MoonModules/WLED-MM, `.github/agent-build.instructions.md` is intentionally kept in `.github/` (not moved to `docs/`) because it is exclusively meant for GitHub Copilot agent tasks, not for CodeRabbit code reviews. It should NOT be referenced in `.coderabbit.yaml` and should not be flagged as misplaced or missing from `docs/`.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

---

🧠 Learnings used

Learnt from: softhack007
Repo: MoonModules/WLED-MM PR: 0
File: :0-0
Timestamp: 2026-04-04T00:29:49.113Z
Learning: In MoonModules/WLED-MM, function-level doc comment blocks (e.g. /* ***** */ style headers) are NOT required during code reviews, especially not for previously existing functions. Do not flag missing function-level comments as review issues in this repository.

---

Learnt from: softhack007
Repo: MoonModules/WLED-MM PR: 0
File: :0-0
Timestamp: 2026-04-04T14:32:02.598Z
Learning: In MoonModules/WLED-MM, clang-format is intentionally NOT enforced via CI or .clang-format config because it would cause merge conflicts when cherry-picking features from upstream WLED (which uses different formatting). Instead, "soft" formatting rules are documented in .github/cpp.instructions.md. Do not recommend adding clang-format to CI as a follow-up to missing automated enforcement — the decision is deliberate.