docs: consolidate documentation and archive temporary reports
Step 1-2 (audit + plan): classified 35 project markdown files into Core/Architecture/ADR/Temporary-audit/Sprint-report/Generated-review/ Duplicate/Obsolete/Historical. Agent-tooling files (.agents/skills/**, .superpowers/**, docs/context/**, CLAUDE.md/GEMINI.md/AGENTS.md/ .github/copilot-instructions.md) explicitly out of scope — intentional per-tool duplication, not documentation debt. Step 3 (merge, no information lost): - docs/PROJECT.md -> docs/PROJECT_INDEX.md, rewritten as the single entry point: system overview, living-doc index, archive pointer, current status, and a critical-finding callout up top. - docs/backend/BACKEND-INTEGRATION.md -> docs/BACKEND_API.md, docs/backend/REMAINING-BACKEND-WORK.md -> docs/BACKEND_API_REMAINING_WORK.md (also folded in a legitimate uncommitted status update that had been sitting unstaged all session: categories marked DONE, order-creation endpoint noted done). - RELEASE-NOTES.md merged into CHANGELOG.md (was a near-duplicate of the same release content in friendlier prose), then deleted. - KNOWN-ISSUES.md: added item 13 (see below) and item 14 (missing canDeactivate on admin/products edit, from the archived PROJECT-STATE audit, re-verified still true); added a correction note to Fixed item 7. - All cross-references to renamed/moved files fixed across every kept doc (grep+sed pass, then verified with a link-existence check across all 58 in-scope markdown files -> 0 broken links). Step 4 (archive, nothing deleted without merging first): created docs/archive/, moved 19 files there (3 root sprint reports, 1 platform report, SPRINT-PLAN.md, and 14 one-off audit/review/report docs). Added correction headers to the 3 archived docs whose conclusions were affected by the finding below, rather than silently leaving them misleading. Step 5: docs/PROJECT_INDEX.md rewritten per the mission brief - someone opening the repo should understand the whole system from it. IMPORTANT FINDING (surfaced during this audit, not the mission's primary goal but too significant to bury): pages/category/*, pages/search/*, pages/item-detail/*, pages/info/**, pages/legal/** (40+ files) are entirely unrouted dead code - app.routes.ts's cmsContentRoutes is a literal empty array, and category/search/product routes redirect to CatalogContainerComponent/ ProductDetailsContainerComponent, not these files. Confirmed against app.routes.ts directly and cross-checked against FRONTEND.md's own routing description. This means several fixes from earlier this cycle (RC-Premium-01, RC STORE-01) and the dead-code cleanup sprint's conclusion that these files were live were all wrong - documented as KNOWN-ISSUES.md item 13, flagged at the top of PROJECT_INDEX.md, and noted on the 3 archived docs whose conclusions it affects. No application code was changed to fix this (out of scope per this session's 'documentation only' constraint) - it needs a wire-it-up-or- delete-it decision first. Verification: tsc --noEmit clean, npm run build green, all markdown links across 58 in-scope files resolve (checked programmatically). No application/Angular/backend code modified. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
153
docs/archive/Platform-Standardization-Report.md
Normal file
153
docs/archive/Platform-Standardization-Report.md
Normal file
@@ -0,0 +1,153 @@
|
||||
# Platform Standardization Report
|
||||
|
||||
Date: 2026-07-09
|
||||
Scope: Sprint 11.5 - Platform Standardization
|
||||
|
||||
## Objective
|
||||
|
||||
Standardize the frontend platform before Admin Platform work without adding new marketplace features.
|
||||
|
||||
## Summary
|
||||
|
||||
The sprint delivered a platform-wide standardization pass across architecture boundaries, legacy cleanup, widget metadata support, translation coverage, theme token normalization, and architecture documentation updates.
|
||||
|
||||
## Files Changed
|
||||
|
||||
- `angular.json`
|
||||
- `src/styles.scss`
|
||||
- `src/assets/mock/bootstrap/widget-manifest.json`
|
||||
- `src/app/theme/tokens/theme-variable-map.ts`
|
||||
- `src/app/theme/mappers/theme-css-vars.mapper.ts`
|
||||
- `src/app/shared/models/config/widget.model.ts`
|
||||
- `src/app/widgets/contracts/widget-manifest.contract.ts`
|
||||
- `src/app/widgets/resolvers/data-source-resolver.service.ts`
|
||||
- `src/app/layouts/containers/dynamic-page-layout.component.ts`
|
||||
- `src/app/components/product-card/product-card.component.ts`
|
||||
- `src/app/components/product-card/product-card.component.html`
|
||||
- `src/app/components/header/header.component.ts`
|
||||
- `src/app/components/header/header.component.html`
|
||||
- `src/app/components/header/header.component.scss`
|
||||
- `src/app/components/language-selector/language-selector.component.scss`
|
||||
- `src/app/components/delivery-selector/delivery-selector.component.scss`
|
||||
- `src/app/components/items-carousel/items-carousel.component.scss`
|
||||
- `src/app/pages/cart/cart.component.html`
|
||||
- `src/app/pages/cart/cart.component.scss`
|
||||
- `src/app/pages/home/home.component.ts`
|
||||
- `src/app/pages/home/home.component.html`
|
||||
- `src/app/pages/home/home.component.scss`
|
||||
- `src/app/pages/item-detail/item-detail.component.scss`
|
||||
- `src/app/pages/public/platform-home.component.ts`
|
||||
- `src/app/pages/backoffice/backoffice-dashboard.component.ts`
|
||||
- `src/app/pages/builder/builder-sandbox.component.ts`
|
||||
- `src/app/widgets/ui/unknown-widget.component.ts`
|
||||
- `src/app/widgets/ui/recently-viewed-widget.component.ts`
|
||||
- `src/app/features/website/user-experience/components/recently-viewed-strip/recently-viewed-strip.component.ts`
|
||||
- `src/app/features/website/user-experience/compare/components/compare-table.component.ts`
|
||||
- `src/app/features/website/user-experience/compare/components/compare-table.component.html`
|
||||
- `src/app/features/website/user-experience/wishlist/containers/wishlist-page.component.ts`
|
||||
- `src/app/i18n/translations.ts`
|
||||
- `src/app/i18n/en.ts`
|
||||
- `src/app/i18n/ru.ts`
|
||||
- `src/app/i18n/hy.ts`
|
||||
- `docs/architecture/foundation/README.md`
|
||||
- `docs/architecture/foundation/Configuration-Standards.md`
|
||||
- `docs/architecture/foundation/Component-Standards.md`
|
||||
- `docs/architecture/foundation/Service-Standards.md`
|
||||
- `src/app/features/website/catalog/services/catalog-search-history.service.ts` (deleted)
|
||||
|
||||
## Technical Debt Removed
|
||||
|
||||
- Removed duplicate catalog search-history service implementation and consolidated on core search history service.
|
||||
- Removed legacy variant naming from active application-layer styles/templates (`novo` / `dexar` remnants in `src/app/**`).
|
||||
- Eliminated hardcoded UI strings identified in audited runtime pages/components by introducing translation keys.
|
||||
- Standardized global token surface for spacing and transition variables.
|
||||
- Added explicit widget metadata support surface for animation/style/permissions and normalized metadata propagation through dynamic rendering.
|
||||
|
||||
## Architecture Audit Result
|
||||
|
||||
Target flow: UI -> Facade -> Domain -> Infrastructure -> Backend
|
||||
|
||||
Result:
|
||||
|
||||
- Audited website feature containers/components for direct forbidden dependencies.
|
||||
- No active component-level `HttpClient` usage found.
|
||||
- No active component-level DTO imports found.
|
||||
- No active component-level `environment` access found.
|
||||
- Facade/container orchestrations remain in place for catalog and product UX flows.
|
||||
|
||||
## Legacy Cleanup Result
|
||||
|
||||
Searched and addressed:
|
||||
|
||||
- `isMarketplaceVariant`
|
||||
- `marketplaceVariant`
|
||||
- `projectName`
|
||||
- legacy variant naming usage in app layer (`novo`, `lavero`, `dexar`)
|
||||
|
||||
Result:
|
||||
|
||||
- No remaining `isMarketplaceVariant`, `marketplaceVariant`, or `projectName` matches in `src/**`.
|
||||
- No remaining `novo`/`lavero` matches in `src/app/**`.
|
||||
|
||||
## Bootstrap Audit Result
|
||||
|
||||
Config representability status:
|
||||
|
||||
- Core page/section/widget configuration remains bootstrap-driven.
|
||||
- Widget metadata support expanded in contracts and dynamic renderer.
|
||||
|
||||
Documented gaps (no backend changes implemented):
|
||||
|
||||
- Full role/permission enforcement for widgets is limited by current auth session shape (no roles/permissions in session model).
|
||||
- Catalog popular-search defaults are still facade-local constants and should be modeled in bootstrap catalog config.
|
||||
- Optional persistent-storage key prefix override is not yet modeled in bootstrap schema.
|
||||
|
||||
## Widget Audit Result
|
||||
|
||||
Support status:
|
||||
|
||||
- `title`: supported
|
||||
- `subtitle`: supported
|
||||
- `visibility`: supported
|
||||
- `layout`: supported
|
||||
- `animation`: supported
|
||||
- `style`: supported
|
||||
- `permissions`: supported (auth-gate baseline)
|
||||
|
||||
## Translation Audit Result
|
||||
|
||||
- Remaining hardcoded UI strings found in audited pages/components were replaced with translation keys.
|
||||
- Translation schema and locale resources were updated for new keys.
|
||||
|
||||
## Theme Audit Result
|
||||
|
||||
Standardized token set ensured:
|
||||
|
||||
- Spacing: `--space-xs`, `--space-sm`, `--space-md`, `--space-lg`, `--space-xl`
|
||||
- Radius: `--radius-sm`, `--radius-md`, `--radius-lg`
|
||||
- Shadows: `--shadow-sm`, `--shadow-md`, `--shadow-lg`
|
||||
- Transitions: `--transition-fast`, `--transition-normal`, `--transition-slow`
|
||||
|
||||
Runtime mapping now propagates spacing/transition tokens through theme engine.
|
||||
|
||||
## Validation
|
||||
|
||||
Executed:
|
||||
|
||||
- `npm run build`
|
||||
- `node tools/architecture/check-boundaries.mjs`
|
||||
|
||||
Expected acceptance target:
|
||||
|
||||
- Build with no warnings
|
||||
- No legacy marketplace conditions in app layer
|
||||
- No environment-driven business logic in feature/business layers
|
||||
- No duplicate implementations in catalog search history path
|
||||
|
||||
## Remaining Recommendations
|
||||
|
||||
1. Extend auth session model/contracts to include role and permission claims, then enforce widget role/permission checks in dynamic layout.
|
||||
2. Move `SearchFacade.popularSearches` to bootstrap `catalog` settings to remove remaining hardcoded discovery defaults.
|
||||
3. Add bootstrap-configurable storage namespace/prefix for all local persistence services.
|
||||
4. Continue translation audit on legacy pages outside audited standardization scope (especially static/legal and long-tail utility pages).
|
||||
5. Consider normalizing project naming in build metadata (`angular.json` project id/output naming) in a dedicated infra-only cleanup sprint.
|
||||
Reference in New Issue
Block a user