Skip to content

[Docs]: comprehensive audit reconciliation and monorepo sync - #196

Merged
Gautam25Raj merged 8 commits into
masterfrom
docs/audit-reconciliation-and-sync
Aug 23, 2026
Merged

[Docs]: comprehensive audit reconciliation and monorepo sync#196
Gautam25Raj merged 8 commits into
masterfrom
docs/audit-reconciliation-and-sync

Conversation

@Gautam25Raj

Copy link
Copy Markdown
Collaborator

Description

This PR resolves all findings from the comprehensive codebase, documentation, and configuration audit across the entire VeriWorkly monorepo (Groups A through H).

Highlights of Changes:

  1. Machine-Readable AI/Agent Layer (Group A):

    • Synchronized OpenAPI spec generation across all 5 web apps via scripts/generate-api-docs.mjs (apps/{docs-platform,site,studio,portfolio,blog-platform}/public/openapi.{json,yaml}).
    • Unified session cookie naming to veriworkly-auth.session_token across all agent cards (.well-known/agent.json).
    • Corrected endpoint paths and synchronized llms.txt / llms-full.txt discovery across apps.
  2. Pricing, Limits & Product Catalog (Group B & Group C):

    • Clarified 50/day paid GitHub profile import limit in site FAQ data.
    • Replaced provider-specific AI branding with provider-agnostic frontier model language across site layout, config, and FAQs.
    • Reconciled standalone annual pricing across all pricing.md files: Creator Pro ($7.99/mo eq, $95.88/yr) and AI Credits ($4.99/mo eq, $59.90/yr).
    • Removed dead portfolioProSevenDayProductId branch in productCatalog.ts.
    • Fixed broken asset references, copied veriworkly-special.svg template preview, and cleaned dead /og-generator route.
  3. Per-App & Package READMEs (Group D):

    • Synchronized apps/server/README.md (cron job count updated to 5, including changelogSyncJob).
    • Corrected blog-platform port to 3003.
    • Updated Studio README with 7 resume and 5 cover letter template details, /share/{username}/{slug} format, and .env.example guidance.
    • Fixed site README ATS quota path to apps/server/src/services/ats/quota.ts and UI package import to import { cn } from "@veriworkly/ui".
    • Updated portfolio README with template creation lifecycle and mock library workflow.
  4. Architecture & Guidelines Sync (Group E & Group F):

    • Documented v3 per-document localStorage scheme (veriworkly:docs:v3:doc:{type}:{id}, veriworkly:docs:v3:index, active pointer, and cache keys) and added useCoverLetterStore in state-management.mdx.
    • Standardized WCAG accessibility target to WCAG 2.2 Level AA across PRODUCT.md, veriworkly.md, and coding-standards.mdx.
    • Fixed repository name references (cd veriworkly), updated README.Local.md dev commands (npm run dev:all), and pinned Node.js requirement to v20.19.0+.
  5. Coordinated Template Documentation (Group G):

    • Updated template catalog numbers across docs/index.mdx, resume-templates.mdx, and creating-your-first-resume.mdx to reflect 7 resume templates + 5 cover letter templates (12 total built-in templates).
    • Synchronized all template listings and blog post counts (21 published posts) across studio/public/llms.txt, site/public/llms.txt, docs-platform/public/llms.txt, and veriworkly.md.
  6. Environment & Contributor Onboarding (Group H):

    • Added all 24 missing variables to apps/server/.env.example (OAuth credentials, AUTH_COOKIE_DOMAIN, ANALYTICS_HASH_PEPPER, DB_POOL_* timeouts, CHANGELOG_*, etc.) and cleaned unread keys.
    • Deleted dead NEXT_PUBLIC_PORTFOLIO_URL and added NEXT_PUBLIC_APP_URL across studio and portfolio envs.
    • Documented scripts/mock-template-library.mjs fallback for building apps/portfolio without private submodule access in apps/portfolio/README.md, local-setup.mdx, monorepo.mdx, and quick-start.mdx.
    • Documented test:browser in coding-standards.mdx and root README.md.
    • Bumped PRICING_VERIFIED_AT to August 2026 in apps/site/config/compare.ts.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 📝 Documentation update
  • 🧪 Tests (adding or updating tests)

Checklist

  • I have read the CONTRIBUTING.md document.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes (636 / 636 passing across workspaces).
  • Any dependent changes have been merged and published in downstream modules.

…discovery layer

Update generate-api-docs.mjs to write bundled openapi.json and openapi.yaml specs across all five consumer applications (docs-platform, site, studio, portfolio, blog-platform). Align session cookie name to veriworkly-auth.session_token and correct API route paths across all .well-known/agent.json files. Update llms.txt and llms-full.txt discovery files across apps with accurate template catalogs and endpoints.
…g consistency

Clarify 50/day paid GitHub import ceiling in site FAQ data. Update AI model branding across site metadata, config, and FAQs to use provider-agnostic frontier language. Reconcile standalone annual pricing across pricing.md files and drop dead portfolioProSevenDayProductId in product catalog. Remove dead /og-generator route and add veriworkly-special resume template preview asset.
…re and configs

Update server README cron job count to 5 and verify routes. Correct blog-platform dev port to 3003. Update studio README with complete 7 resume + 5 cover letter catalog, correct share URL structure, and .env.example guidance. Fix site README accuracy contract paths and FAQ dataset documentation. Update packages/ui README import path to @veriworkly/ui, cleanup dependencies, and list all consumer apps. Update portfolio README with template creation workflow and mock library fallback.
…with current state

Document v3 per-document localStorage layout and add useCoverLetterStore to state-management docs. Align WCAG accessibility target across PRODUCT.md, veriworkly.md, and coding standards to WCAG 2.2 Level AA. Update template guides and tables with all 12 templates (7 resume + 5 cover letter). Document stand-in mock template workflow for portfolio building without private submodule access, and update veriworkly.md verification date and blog counts.
…tor setup guides

Add 24 missing variables to apps/server/.env.example and remove unread keys. Delete dead NEXT_PUBLIC_PORTFOLIO_URL and add NEXT_PUBLIC_APP_URL in studio and portfolio environment examples. Update ENV_SETUP.md with required Redis documentation and comprehensive environment templates for all workspaces. Fix directory paths, Node.js version requirements, and script references in root README, README.Local, QUICK_START, and CONTRIBUTING.
…ment mdx expressions

Add Build Shared Packages step to GitHub Actions builds.yaml and tests.yaml workflows so @veriworkly/profile-core is compiled before app builds and unit tests execute. Fix LaTeX math expressions in state-management.mdx that caused acorn MDX parser errors during static docs compilation.
…rose helpers

Add full helper functions (itemLabel, itemProse, itemFirst, itemList, itemLinkUrl, formatPeriod) to mock template library typesContent so portfolio projection contract tests pass in CI.
Bump root and workspace package versions to 3.24.1 across apps/site, apps/studio, apps/portfolio, apps/blog-platform, apps/docs-platform, and apps/server. Update UI shell and not-found build release tags.
@Gautam25Raj Gautam25Raj changed the title docs: comprehensive audit reconciliation and monorepo sync [Docs]: comprehensive audit reconciliation and monorepo sync Aug 23, 2026
@Gautam25Raj
Gautam25Raj merged commit 600fb59 into master Aug 23, 2026
11 checks passed
@Gautam25Raj Gautam25Raj added the documentation Improvements or additions to documentation label Aug 23, 2026
@Gautam25Raj
Gautam25Raj deleted the docs/audit-reconciliation-and-sync branch August 25, 2026 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant