[Docs]: comprehensive audit reconciliation and monorepo sync - #196
Merged
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Machine-Readable AI/Agent Layer (Group A):
scripts/generate-api-docs.mjs(apps/{docs-platform,site,studio,portfolio,blog-platform}/public/openapi.{json,yaml}).veriworkly-auth.session_tokenacross all agent cards (.well-known/agent.json).llms.txt/llms-full.txtdiscovery across apps.Pricing, Limits & Product Catalog (Group B & Group C):
pricing.mdfiles: Creator Pro ($7.99/mo eq, $95.88/yr) and AI Credits ($4.99/mo eq, $59.90/yr).portfolioProSevenDayProductIdbranch inproductCatalog.ts.veriworkly-special.svgtemplate preview, and cleaned dead/og-generatorroute.Per-App & Package READMEs (Group D):
apps/server/README.md(cron job count updated to 5, includingchangelogSyncJob)./share/{username}/{slug}format, and.env.exampleguidance.apps/server/src/services/ats/quota.tsand UI package import toimport { cn } from "@veriworkly/ui".Architecture & Guidelines Sync (Group E & Group F):
veriworkly:docs:v3:doc:{type}:{id},veriworkly:docs:v3:index, active pointer, and cache keys) and addeduseCoverLetterStoreinstate-management.mdx.PRODUCT.md,veriworkly.md, andcoding-standards.mdx.cd veriworkly), updatedREADME.Local.mddev commands (npm run dev:all), and pinned Node.js requirement tov20.19.0+.Coordinated Template Documentation (Group G):
docs/index.mdx,resume-templates.mdx, andcreating-your-first-resume.mdxto reflect 7 resume templates + 5 cover letter templates (12 total built-in templates).studio/public/llms.txt,site/public/llms.txt,docs-platform/public/llms.txt, andveriworkly.md.Environment & Contributor Onboarding (Group H):
apps/server/.env.example(OAuth credentials,AUTH_COOKIE_DOMAIN,ANALYTICS_HASH_PEPPER,DB_POOL_*timeouts,CHANGELOG_*, etc.) and cleaned unread keys.NEXT_PUBLIC_PORTFOLIO_URLand addedNEXT_PUBLIC_APP_URLacross studio and portfolio envs.scripts/mock-template-library.mjsfallback for buildingapps/portfoliowithout private submodule access inapps/portfolio/README.md,local-setup.mdx,monorepo.mdx, andquick-start.mdx.test:browserincoding-standards.mdxand rootREADME.md.PRICING_VERIFIED_ATtoAugust 2026inapps/site/config/compare.ts.Type of Change
Checklist