Skip to content

chore: untrack docs/specs and add to gitignore - #931

Open
gdsmith1 wants to merge 1 commit into
masterfrom
chore/untrack-docs-specs
Open

chore: untrack docs/specs and add to gitignore#931
gdsmith1 wants to merge 1 commit into
masterfrom
chore/untrack-docs-specs

Conversation

@gdsmith1

@gdsmith1 gdsmith1 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Untracks SDD planning artifacts under docs/specs/ so they no longer live in git. Index-only removal — no working-tree deletions, no history rewrite.

What Changed

  • .gitignore: uncommented docs/specs/ (line 44)
  • git rm -r --cached docs/specs/: 34 previously-tracked files removed from index

Why

Planning artifacts (specs, tasks, audits, proofs) are local coordination documents for the SDD workflow. They churn constantly, bloat PR diffs, and add no value to consumers of the bootcamp. Untracking removes the noise while preserving history and local files.

Verification

Ran locally on branch (all output captured in docs/specs/04-spec-issues-and-deps-cleanup/04-proofs/04-task-01-proofs.md, which itself is now untracked — self-referential by design):

Check Command Result
Index clean git ls-files docs/specs/ | wc -l 0
Working tree preserved ls docs/specs/ | wc -l 9
History preserved git log --oneline -1 -- docs/specs/ 8048702 Funny insects/keda exercise refactor (#878)
SDD workflow unbroken assess-sdd-state.py . 8 active specs — identical to pre-change baseline
Staged diff scope git diff --cached --stat 35 files: .gitignore +1 line; 34 spec files deleted from index

Merge Safety

Sibling PRs in Spec 04 (tasks 2.0–8.0) are authored so none write to docs/specs/**. Merge order between this PR and the siblings is unconstrained.

Spec

Part of Spec 04 (04-spec-issues-and-deps-cleanup), Task 1.0. Related plaintext job: untrack docs/specs/ planning artifacts.

Summary by CodeRabbit

  • Documentation

    • Removed obsolete planning, questionnaire, task, validation, and proof-artifact documents across multiple learning topics.
    • Cleared outdated specification content to keep the documentation repository focused on current materials.
  • Chores

    • Updated repository ignore rules so specification working files are excluded from version control.

- uncomment docs/specs/ in .gitignore
- git rm -r --cached all previously-tracked docs/specs/** paths
- working tree preserved; history preserved; no rewrite

Related to T1 in Spec 04
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: cad28616-223f-4eee-96ed-74f81038d621

📥 Commits

Reviewing files that changed from the base of the PR and between 9cd0758 and bfbc4f8.

📒 Files selected for processing (35)
  • .gitignore
  • docs/specs/00-spec-chapter-11-appdev/00-spec-chapter-11-appdev.md
  • docs/specs/01-spec-design-patterns-section/01-proofs/01-task-01-proofs.md
  • docs/specs/01-spec-design-patterns-section/01-questions-1-design-patterns-section.md
  • docs/specs/01-spec-design-patterns-section/01-spec-design-patterns-section.md
  • docs/specs/01-spec-design-patterns-section/01-tasks-design-patterns-section.md
  • docs/specs/01-spec-design-patterns-section/task-1.0-github-issue.md
  • docs/specs/01-spec-keda-exercise/01-proofs/01-task-01-proofs.md
  • docs/specs/01-spec-keda-exercise/01-proofs/01-task-02-proofs.md
  • docs/specs/01-spec-keda-exercise/01-proofs/01-task-03-proofs.md
  • docs/specs/01-spec-keda-exercise/01-questions-1-keda-exercise.md
  • docs/specs/01-spec-keda-exercise/01-spec-keda-exercise.md
  • docs/specs/01-spec-keda-exercise/01-tasks-keda-exercise.md
  • docs/specs/02-spec-system-thinking/02-questions-1-system-thinking.md
  • docs/specs/02-spec-system-thinking/02-spec-system-thinking.md
  • docs/specs/02-spec-system-thinking/02-tasks-system-thinking.md
  • docs/specs/03-spec-databases/03-questions-1-databases.md
  • docs/specs/03-spec-databases/03-spec-databases.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-01-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-02-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-03-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-04-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-05-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-06-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-questions-1-ai-engineering-modern-practices.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-spec-ai-engineering-modern-practices.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-tasks-ai-engineering-modern-practices.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-01-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-02-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-03-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-04-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-questions-1-bootcamp-rename.md
  • docs/specs/99-spec-bootcamp-rename/99-spec-bootcamp-rename.md
  • docs/specs/99-spec-bootcamp-rename/99-tasks-bootcamp-rename.md
  • docs/specs/99-spec-bootcamp-rename/99-validation-bootcamp-rename.md
💤 Files with no reviewable changes (34)
  • docs/specs/01-spec-keda-exercise/01-proofs/01-task-03-proofs.md
  • docs/specs/01-spec-design-patterns-section/01-questions-1-design-patterns-section.md
  • docs/specs/02-spec-system-thinking/02-questions-1-system-thinking.md
  • docs/specs/02-spec-system-thinking/02-tasks-system-thinking.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-03-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-04-proofs.md
  • docs/specs/02-spec-system-thinking/02-spec-system-thinking.md
  • docs/specs/01-spec-keda-exercise/01-spec-keda-exercise.md
  • docs/specs/01-spec-design-patterns-section/01-proofs/01-task-01-proofs.md
  • docs/specs/01-spec-keda-exercise/01-questions-1-keda-exercise.md
  • docs/specs/01-spec-design-patterns-section/task-1.0-github-issue.md
  • docs/specs/99-spec-bootcamp-rename/99-tasks-bootcamp-rename.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-04-proofs.md
  • docs/specs/03-spec-databases/03-spec-databases.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-questions-1-ai-engineering-modern-practices.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-spec-ai-engineering-modern-practices.md
  • docs/specs/03-spec-databases/03-questions-1-databases.md
  • docs/specs/99-spec-bootcamp-rename/99-validation-bootcamp-rename.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-02-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-tasks-ai-engineering-modern-practices.md
  • docs/specs/99-spec-bootcamp-rename/99-questions-1-bootcamp-rename.md
  • docs/specs/01-spec-keda-exercise/01-proofs/01-task-02-proofs.md
  • docs/specs/01-spec-design-patterns-section/01-spec-design-patterns-section.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-05-proofs.md
  • docs/specs/01-spec-design-patterns-section/01-tasks-design-patterns-section.md
  • docs/specs/00-spec-chapter-11-appdev/00-spec-chapter-11-appdev.md
  • docs/specs/01-spec-keda-exercise/01-tasks-keda-exercise.md
  • docs/specs/01-spec-keda-exercise/01-proofs/01-task-01-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-06-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-03-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-01-proofs.md
  • docs/specs/98-spec-ai-engineering-modern-practices/98-proofs/98-task-02-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-proofs/99-task-01-proofs.md
  • docs/specs/99-spec-bootcamp-rename/99-spec-bootcamp-rename.md

📝 Walkthrough

Walkthrough

The change activates an ignore rule for docs/specs/ and removes the existing Chapter 11, design-patterns, KEDA, system-thinking, databases, AI-engineering, and bootcamp-rename specification documents and proof artifacts.

Changes

Specification cleanup

Layer / File(s) Summary
Ignore specifications directory
.gitignore
Activates the docs/specs/ ignore pattern.
Remove obsolete specification documents
docs/specs/00-spec-chapter-11-appdev/..., docs/specs/01-spec-*/..., docs/specs/02-spec-system-thinking/..., docs/specs/03-spec-databases/..., docs/specs/98-spec-ai-engineering-modern-practices/..., docs/specs/99-spec-bootcamp-rename/...
Removes the listed specification, questionnaire, task, validation, and proof-artifact Markdown documents.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 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 accurately summarizes the main change: untracking docs/specs and adding it to .gitignore.
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/untrack-docs-specs

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

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant