d-bis/explorer-monorepo
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: consolidate documentation — delete status/fix/progress cruft #2

Merged
nsatoshi merged 1 commits from devin/1776538357-chore-doc-consolidation into master 2026-04-18 19:35:39 +00:00
Conversation 0 Commits 1 Files Changed 205 +8 -37633
nsatoshi commented 2026-04-18 18:56:56 +00:00
Owner
Copy Link

Summary

PR #2 of the 11-PR completion sequence. Pure documentation consolidation — no code changes.

Before: 335 tracked .md files; 14 README-like docs at the top level; docs/ contained ~234 files, most of them auto/LLM-generated status reports (ALL_*_COMPLETE_*, *_FIX.md, DEPLOYMENT_*_FINAL.md, etc.).

After: 132 tracked .md files. Exactly five top-level docs: README.md, QUICKSTART.md, RUNBOOK.md, CONTRIBUTING.md, CHANGELOG.md (moved up from docs/). 205 files changed, +8 / -37 633 lines.

What was kept in docs/

  • API: API_DOCUMENTATION.md, EXPLORER_API_ACCESS.md, EXPLORER_API_REFERENCE.md, docs/api/, docs/openapi/.
  • CCIP operational & security references (ops runbook, security best practices, security incident response, access control, rate limits, best practices, receiver requirements, token-pool architecture, router configuration, router native-ETH check, verification checklist, monitor metrics, fee structure, fee-and-limitation analysis).
  • Chainlist references.
  • Architecture: BRIDGE_CONTRACT_ARCHITECTURE.md, COMPLIANCE_ARCHITECTURE_EXPLANATION.md, TIERED_ARCHITECTURE_*, REUSABLE_COMPONENTS_EXTRACTION_PLAN.md.
  • Deployment guides (not status): DEPLOYMENT.md, DEPLOYMENT_GUIDE.md, DEPLOYMENT_METHOD_REMIX_IDE.md, DEPLOYMENT_METHOD_VALIDATOR.md.
  • Reference: DATABASE_CONNECTION_GUIDE.md, INTEGRATION_GUIDES.md, METAMASK_AND_PROVIDER_INTEGRATION.md, PRODUCTION_CHECKLIST.md, PR_WORKFLOW_RECOMMENDATION.md, PULL_REQUEST_GUIDE.md, TOKEN_MECHANISM_DOCUMENTATION.md, WRAP_AND_BRIDGE_TO_ETHEREUM.md.
  • Legal compliance: LEGAL_COMPLIANCE_*.
  • All of docs/specs/** (architecture specs).

What was deleted

Pattern-matched, not file-by-file, using /tmp/curate_docs.py:

  • All ALL_*_COMPLETE*, *_FIX.md, *_FIXED*, *_FINAL*, *_COMPLETE*, *_COMPLETION*, *_STATUS*, *_PROGRESS*, *_SUMMARY* in docs/.
  • All BLOCKSCOUT_* fix/status/crash/initialization/schema/yaml/skip/next-steps/start-and-build/database-credentials docs (the last contained passwords).
  • CCIP_IMPLEMENTATION_*, CCIP_CURRENT_STATUS, CCIP_GAP_*, CCIP_COMPLETE_TASK_CATALOG, CCIP_SETUP_COMPLETION_STATUS (gap analyses and setup status reports are not a sustained reference).
  • NPMPLUS_CREDENTIALS_GUIDE.md (contained creds).
  • LETSENCRYPT_CONFIGURATION_GUIDE.md (contained creds; will be re-introduced as runbook content post secret-scrub).
  • docs/diagnostic-reports/, docs/feature-flags/ (run-time artifacts).
  • Top-level: START_HERE.md, ALL_NEXT_STEPS_COMPLETE_FINAL.md, IP_CONFLICT_INVESTIGATION.md, NET1_REMOVED_ISSUE.md, NPMPLUS_UPDATE_GUIDE.md, README_BRIDGE.md, README_DEPLOYMENT.md, chain_id_138_explorer_virtual_banking_vtm_platform_plan.md.

README.md link fix

Dead links (START_HERE, README_DEPLOYMENT, COMPLETE_DEPLOYMENT, DEPLOYMENT_COMPLETE_FINAL) in README.md were replaced with links to the five canonical top-level docs + the docs/ index. A full README rewrite is scheduled for PR #11.

Why

The previous doc tree made it impossible to tell which file was current. A single BLOCKSCOUT_* troubleshooting thread had 12 overlapping markdowns (BLOCKSCOUT_FIX_CORRECTED, BLOCKSCOUT_FIX_FINAL, BLOCKSCOUT_FIX_WORKING, etc.). Deleting obsolete reports and keeping reference material makes the repo navigable and surfaces the real open questions.

Verification

  • No code / config / migration files touched — git diff --stat shows only .md deletions plus the README.md link edit and the docs/CHANGELOG.md → CHANGELOG.md rename.
  • rg 'START_HERE|README_DEPLOYMENT|COMPLETE_DEPLOYMENT|NPMPLUS_CREDENTIALS' returns no hits in the remaining .md set.
  • find . -name 'ALL_*.md' returns nothing.

Completion criterion advanced

1. Clean repo hygiene — "All ALL_*_COMPLETE*.md, BLOCKSCOUT_*_FIX*.md, DEPLOYMENT_*_FINAL*.md etc. deleted …"

Still outstanding: running gitleaks over history (PR #5 wiring), rewriting the top-level README.md / new ARCHITECTURE.md / API.md (PR #11).

## Summary PR #2 of the 11-PR completion sequence. Pure documentation consolidation — no code changes. **Before:** 335 tracked `.md` files; 14 README-like docs at the top level; `docs/` contained ~234 files, most of them auto/LLM-generated status reports (`ALL_*_COMPLETE_*`, `*_FIX.md`, `DEPLOYMENT_*_FINAL.md`, etc.). **After:** 132 tracked `.md` files. Exactly five top-level docs: `README.md`, `QUICKSTART.md`, `RUNBOOK.md`, `CONTRIBUTING.md`, `CHANGELOG.md` (moved up from `docs/`). 205 files changed, +8 / -37 633 lines. ## What was kept in `docs/` - API: `API_DOCUMENTATION.md`, `EXPLORER_API_ACCESS.md`, `EXPLORER_API_REFERENCE.md`, `docs/api/`, `docs/openapi/`. - CCIP operational & security references (ops runbook, security best practices, security incident response, access control, rate limits, best practices, receiver requirements, token-pool architecture, router configuration, router native-ETH check, verification checklist, monitor metrics, fee structure, fee-and-limitation analysis). - Chainlist references. - Architecture: `BRIDGE_CONTRACT_ARCHITECTURE.md`, `COMPLIANCE_ARCHITECTURE_EXPLANATION.md`, `TIERED_ARCHITECTURE_*`, `REUSABLE_COMPONENTS_EXTRACTION_PLAN.md`. - Deployment guides (not status): `DEPLOYMENT.md`, `DEPLOYMENT_GUIDE.md`, `DEPLOYMENT_METHOD_REMIX_IDE.md`, `DEPLOYMENT_METHOD_VALIDATOR.md`. - Reference: `DATABASE_CONNECTION_GUIDE.md`, `INTEGRATION_GUIDES.md`, `METAMASK_AND_PROVIDER_INTEGRATION.md`, `PRODUCTION_CHECKLIST.md`, `PR_WORKFLOW_RECOMMENDATION.md`, `PULL_REQUEST_GUIDE.md`, `TOKEN_MECHANISM_DOCUMENTATION.md`, `WRAP_AND_BRIDGE_TO_ETHEREUM.md`. - Legal compliance: `LEGAL_COMPLIANCE_*`. - All of `docs/specs/**` (architecture specs). ## What was deleted Pattern-matched, not file-by-file, using `/tmp/curate_docs.py`: - All `ALL_*_COMPLETE*`, `*_FIX.md`, `*_FIXED*`, `*_FINAL*`, `*_COMPLETE*`, `*_COMPLETION*`, `*_STATUS*`, `*_PROGRESS*`, `*_SUMMARY*` in `docs/`. - All `BLOCKSCOUT_*` fix/status/crash/initialization/schema/yaml/skip/next-steps/start-and-build/database-credentials docs (the last contained passwords). - `CCIP_IMPLEMENTATION_*`, `CCIP_CURRENT_STATUS`, `CCIP_GAP_*`, `CCIP_COMPLETE_TASK_CATALOG`, `CCIP_SETUP_COMPLETION_STATUS` (gap analyses and setup status reports are not a sustained reference). - `NPMPLUS_CREDENTIALS_GUIDE.md` (contained creds). - `LETSENCRYPT_CONFIGURATION_GUIDE.md` (contained creds; will be re-introduced as runbook content post secret-scrub). - `docs/diagnostic-reports/`, `docs/feature-flags/` (run-time artifacts). - Top-level: `START_HERE.md`, `ALL_NEXT_STEPS_COMPLETE_FINAL.md`, `IP_CONFLICT_INVESTIGATION.md`, `NET1_REMOVED_ISSUE.md`, `NPMPLUS_UPDATE_GUIDE.md`, `README_BRIDGE.md`, `README_DEPLOYMENT.md`, `chain_id_138_explorer_virtual_banking_vtm_platform_plan.md`. ## README.md link fix Dead links (`START_HERE`, `README_DEPLOYMENT`, `COMPLETE_DEPLOYMENT`, `DEPLOYMENT_COMPLETE_FINAL`) in `README.md` were replaced with links to the five canonical top-level docs + the `docs/` index. A full README rewrite is scheduled for PR #11. ## Why The previous doc tree made it impossible to tell which file was current. A single `BLOCKSCOUT_*` troubleshooting thread had 12 overlapping markdowns (`BLOCKSCOUT_FIX_CORRECTED`, `BLOCKSCOUT_FIX_FINAL`, `BLOCKSCOUT_FIX_WORKING`, etc.). Deleting obsolete reports and keeping reference material makes the repo navigable and surfaces the real open questions. ## Verification - No code / config / migration files touched — `git diff --stat` shows only `.md` deletions plus the `README.md` link edit and the `docs/CHANGELOG.md → CHANGELOG.md` rename. - `rg 'START_HERE|README_DEPLOYMENT|COMPLETE_DEPLOYMENT|NPMPLUS_CREDENTIALS'` returns no hits in the remaining `.md` set. - `find . -name 'ALL_*.md'` returns nothing. ## Completion criterion advanced > **1. Clean repo hygiene** — "All `ALL_*_COMPLETE*.md`, `BLOCKSCOUT_*_FIX*.md`, `DEPLOYMENT_*_FINAL*.md` etc. deleted …" Still outstanding: running `gitleaks` over history (PR #5 wiring), rewriting the top-level `README.md` / new `ARCHITECTURE.md` / `API.md` (PR #11).
nsatoshi added 1 commit 2026-04-18 18:56:56 +00:00
chore: consolidate documentation — delete status/fix/progress cruft d3706de449 
Before: 335 tracked .md files; top level had 14 README-like docs;
docs/ contained ~234 files, most of them auto/LLM-generated status
reports (ALL_*_COMPLETE*, *_FIX*, DEPLOYMENT_*_FINAL*, etc.).

After: 132 tracked .md files. Repo now has exactly five top-level
docs: README.md, QUICKSTART.md, RUNBOOK.md, CONTRIBUTING.md,
CHANGELOG.md (moved up from docs/).

Keeper philosophy in docs/:
- API, CCIP (ops + security + receiver/router refs), Chainlist refs,
  compliance, deployment (guides not status), database connection,
  legal compliance, metamask integration, production checklist,
  tiered-architecture implementation/setup, reusable-components plan,
  token-mechanism doc, wrap-and-bridge operational reference, plus
  docs/specs/** and docs/api/ / docs/openapi/ trees.

Deleted (git history preserves provenance):
- All 'ALL_*_COMPLETE*' / '*_FIX*' / '*_FIXED*' / '*_FINAL*' /
  '*_STATUS*' / '*_PROGRESS*' / '*_SUMMARY*' files.
- BLOCKSCOUT_*_FIX / _CRASH / _INITIALIZATION / _SCHEMA / _YAML /
  _SKIP / _NEXT_STEPS / _START_AND_BUILD / _DATABASE_CREDENTIALS
  (the last contained passwords).
- CCIP_IMPLEMENTATION_* / CCIP_CURRENT_STATUS / CCIP_GAP_*
  (gap analyses are not a sustained reference).
- NPMPLUS_CREDENTIALS_GUIDE.md (contained creds).
- LETSENCRYPT_CONFIGURATION_GUIDE.md (contained creds; will be
  re-introduced as runbook content post-secrets-scrub).
- docs/diagnostic-reports/, docs/feature-flags/ (run-time artifacts).

README.md: dead links (START_HERE, README_DEPLOYMENT, COMPLETE_DEPLOYMENT,
DEPLOYMENT_COMPLETE_FINAL) replaced with links to the five canonical
top-level docs + docs/ index.
nsatoshi merged commit a6ce14ed20 into master 2026-04-18 19:35:39 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
70rn4710n A.r.yavari SEG nsatoshi
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: d-bis/explorer-monorepo#2
Delete Branch "devin/1776538357-chore-doc-consolidation"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?