Skip to content

docs(browser-storage-inspector): remove redundant README.md - #464

Merged
Facelessism merged 9 commits into
Facelessism:mainfrom
PrathamReddy888:Doc-Remove-redundant-README.md-#305
Aug 8, 2026
Merged

docs(browser-storage-inspector): remove redundant README.md#464
Facelessism merged 9 commits into
Facelessism:mainfrom
PrathamReddy888:Doc-Remove-redundant-README.md-#305

Conversation

@PrathamReddy888

Copy link
Copy Markdown
Contributor

Title

docs: remove redundant README.md from browser-storage-inspector

Summary

Resolves #305
removes the redundant README.md from projects/dev-tools/browser-storage-inspector/.

Across the repository, the standard documentation format is a single ARCHITECTURE.md per mini project. This project was the only one carrying both files. Other README.md files under projects/ belong to projects that do not yet have an ARCHITECTURE.md and will be cleaned up separately.

This PR ensures consistency by keeping ARCHITECTURE.md (the canonical doc per repo convention) and removing the overlapping README.md.

Changes Made

  • Deleted

    • projects/dev-tools/browser-storage-inspector/README.md
  • Updated

    • projects/dev-tools/browser-storage-inspector/ARCHITECTURE.md
      • Removed the single line:
        ├── README.md # User-facing features and usage guide
        
        • Ensures the documented folder structure matches the actual file layout.
      • All other content unchanged.
  • Added

    • tests/architecture-validation.test.js
      • New regression test for Issue Doc: Remove redundant README.md #305:
        • Asserts that no mini project has both a README.md and an ARCHITECTURE.md.
        • Walks projects/ and fails if any directory contains both files.
        • Guards against redundancy silently returning via future PRs.

Related Issue

Closes #305

Type of Change

  • 🐛 Bug fix
  • ✨ New feature
  • 📝 Documentation update
  • 🎨 UI/style change
  • ♻️ Refactor (no functional change)
  • 🧪 Tests
  • ⚙️ CI/tooling

Why This Matters

  • README.md and ARCHITECTURE.md overlapped — both documented the project’s purpose, file roles, and responsibilities of storageEngine.js, storageExporter.js, script.js, and style.css.
  • Repo convention — every other mini project with documentation uses only ARCHITECTURE.md.
  • Validation coverage — CI scripts already validate ARCHITECTURE.md but not README.md.
  • RichnessARCHITECTURE.md includes Mermaid flowcharts, a formal component breakdown table, and matches the ARCHITECTURE_TEMPLATE.md structure.

Keeping ARCHITECTURE.md ensures consistency, richer documentation, and continued CI validation.

Acceptance Criteria

  • README.md removed from browser-storage-inspector.
  • ARCHITECTURE.md updated to reflect actual folder layout.
  • Regression test added to prevent both files from coexisting in future.
  • Existing architecture validation continues to pass.
  • CI scripts (validate:architecture, validate:mini-projects) remain unaffected.

Verification

npm test
npm run validate:architecture
npm run validate:mini-projects

Results:

  • npm test — new regression test passes (no mini project has both files). Existing tests continue to pass.
  • npm run validate:architecturebrowser-storage-inspector still has ARCHITECTURE.md with required headings.
  • npm run validate:mini-projectsREADME.md is not part of REQUIRED_STANDARD_FILES, so removal has no effect.

Checklist

  • I am a ECSOC26 contributor
  • I have read [Looks like the result wasn't safe to show. Let's switch things up and try something else!]
  • My branch is up-to-date with main
  • I have tested my changes locally
  • I have not merged my own PR
  • I have verified that licensing and third-party asset attributions are explicitly documented (if applicable)
  • My code follows the project’s coding style
  • Documentation has been updated where necessary (removed redundant README.md, updated ARCHITECTURE.md folder listing, added regression test)
  • My changes do not introduce new warnings or errors

Packages Added (if any)

None.

Screenshots / Video (if applicable)

(N/A — documentation and tests only, no UI changes)

@vercel

vercel Bot commented Aug 8, 2026

Copy link
Copy Markdown

@PrathamReddy888 is attempting to deploy a commit to the facelessism Team on Vercel.

A member of the Team first needs to authorize it.

@PrathamReddy888

Copy link
Copy Markdown
Contributor Author

Architecture validation — 31 non-compliant files
This is a pre-existing repo-wide issue. The ARCHITECTURE_TEMPLATE.md requires 16 sections (## Overview, ## Purpose & Goals, ## Folder Structure, ## System / Project Architecture Overview, ## Component Breakdown, ## Data Flow / Execution Flow, ## Key Features, ## Technologies Used, ## File Responsibilities, ## Design Decisions, ## Dependencies, ## Future Improvements, ## Known Limitations, ## Development Notes, ## License & Attribution, ## References). 31 files don't have all of them.

This is not something PR #464 can or should fix. My PR only touched browser-storage-inspector.

@PrathamReddy888

Copy link
Copy Markdown
Contributor Author

@Facelessism

The other 30 non-compliant files are pre-existing on main. My PR can't fix them.

Also this pr is not "Newbie-only" This required a lot of code refactoring that I did, Kindly review.

Please add appropriate ecsoc labels,
and merge.

@Facelessism
Facelessism merged commit 64b38c5 into Facelessism:main Aug 8, 2026
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc: Remove redundant README.md

2 participants