Skip to content

PRODUCT.md

Latest commit

 

History

History
52 lines (31 loc) · 2.33 KB

PRODUCT.md

File metadata and controls

52 lines (31 loc) · 2.33 KB
Raw

Product

Platform

web

Users

Developers and technical evaluators who use Foundry Toolkit for VS Code and need to understand what changed between extension releases.

Product Purpose

The changelog turns the repository's release history into a readable, searchable web archive. Success means a reader can quickly find a version, scan its date and summary, and understand added, changed, and fixed behavior without leaving the page.

Positioning

The site is generated directly from the extension's canonical WHATS_NEW.md, so the public release archive and repository-authored release notes stay aligned.

Operating Context

Readers arrive from the Foundry Toolkit repository, Visual Studio Marketplace, or a shared release link. They browse by version, filter the archive, follow deep links, switch between light and dark themes, and continue to the repository or Marketplace when needed.

Capabilities and Constraints

  • WHATS_NEW.md remains the single source of release content.
  • The static site is generated by site/build.mjs and published through GitHub Pages.
  • Release filtering, keyboard search focus, scroll-spy navigation, deep links, responsive layouts, and light/dark themes must remain available.
  • Generated output in site/dist is not edited directly.

Brand Commitments

Use the Foundry Toolkit for VS Code name and existing Microsoft, GitHub, and Visual Studio Marketplace destinations. The changelog should use the familiar structure and visual language of the Visual Studio Code release-notes site without presenting itself as the VS Code product.

Evidence on Hand

  • Release content: WHATS_NEW.md
  • Existing generator and interactions: site/build.mjs, site/assets/app.js
  • Existing static-site deployment documentation: site/README.md
  • Visual reference confirmed by the user: https://code.visualstudio.com/updates/v1_131

Product Principles

  • Release content stays authoritative and unembellished.
  • Reading and version wayfinding take priority over decorative UI.
  • Familiar VS Code release-note conventions reduce orientation cost.
  • Every interaction remains usable with keyboard, touch, and narrow screens.

Accessibility & Inclusion

Preserve semantic navigation, headings, skip links, visible keyboard focus, reduced-motion support, and readable contrast in both themes.