docs(browser-storage-inspector): remove redundant README.md - #464
Conversation
|
@PrathamReddy888 is attempting to deploy a commit to the facelessism Team on Vercel. A member of the Team first needs to authorize it. |
Added UMD wrapper to expose DotGameEngine for browser and Node.js.
|
Architecture validation — 31 non-compliant files This is not something PR #464 can or should fix. My PR only touched browser-storage-inspector. |
|
The other 30 non-compliant files are pre-existing on Also this pr is not "Newbie-only" This required a lot of code refactoring that I did, Kindly review. Please add appropriate ecsoc labels, |
Title
docs: remove redundant README.md from browser-storage-inspector
Summary
Resolves #305
removes the redundant
README.mdfromprojects/dev-tools/browser-storage-inspector/.Across the repository, the standard documentation format is a single
ARCHITECTURE.mdper mini project. This project was the only one carrying both files. OtherREADME.mdfiles underprojects/belong to projects that do not yet have anARCHITECTURE.mdand will be cleaned up separately.This PR ensures consistency by keeping
ARCHITECTURE.md(the canonical doc per repo convention) and removing the overlappingREADME.md.Changes Made
Deleted
projects/dev-tools/browser-storage-inspector/README.mdUpdated
projects/dev-tools/browser-storage-inspector/ARCHITECTURE.mdAdded
tests/architecture-validation.test.jsREADME.mdand anARCHITECTURE.md.projects/and fails if any directory contains both files.Related Issue
Closes #305
Type of Change
Why This Matters
storageEngine.js,storageExporter.js,script.js, andstyle.css.ARCHITECTURE.md.ARCHITECTURE.mdbut notREADME.md.ARCHITECTURE.mdincludes Mermaid flowcharts, a formal component breakdown table, and matches theARCHITECTURE_TEMPLATE.mdstructure.Keeping
ARCHITECTURE.mdensures consistency, richer documentation, and continued CI validation.Acceptance Criteria
README.mdremoved frombrowser-storage-inspector.ARCHITECTURE.mdupdated to reflect actual folder layout.validate:architecture,validate:mini-projects) remain unaffected.Verification
npm test npm run validate:architecture npm run validate:mini-projectsResults:
npm test— new regression test passes (no mini project has both files). Existing tests continue to pass.npm run validate:architecture—browser-storage-inspectorstill hasARCHITECTURE.mdwith required headings.npm run validate:mini-projects—README.mdis not part ofREQUIRED_STANDARD_FILES, so removal has no effect.Checklist
[Looks like the result wasn't safe to show. Let's switch things up and try something else!]mainPackages Added (if any)
None.
Screenshots / Video (if applicable)
(N/A — documentation and tests only, no UI changes)