From 1a8b60548803a227212e9f8ffc2d728781fd5aee Mon Sep 17 00:00:00 2001 From: nicolethoen Date: Wed, 18 Mar 2026 17:34:26 -0400 Subject: [PATCH] chore: add agentic guidance --- BOOKMARKS.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ CLAUDE.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+) create mode 100644 BOOKMARKS.md create mode 100644 CLAUDE.md diff --git a/BOOKMARKS.md b/BOOKMARKS.md new file mode 100644 index 0000000..aa91ae1 --- /dev/null +++ b/BOOKMARKS.md @@ -0,0 +1,48 @@ +# Bookmarks + +Progressive disclosure for task-specific documentation and references. + +## Table of Contents +- [PatternFly Documentation](#patternfly-documentation) +- [Design & Guidelines](#design--guidelines) +- [Development Resources](#development-resources) + +--- + +## PatternFly Documentation + +### [PatternFly 6 React Docs](https://www.patternfly.org/) + +Official PatternFly 6 React component documentation and API reference. + +**Added by**: Initial setup | **Date**: 2026-03-18 + +### [PatternFly MCP Server](https://www.npmjs.com/package/@patternfly/patternfly-mcp) + +MCP server for PatternFly development rules and documentation - use with Ambient/Claude for inline guidance. + +**Added by**: Initial setup | **Date**: 2026-03-18 + +--- + +## Design & Guidelines + +### [Design Guidelines (Local)](./packages/module/patternfly-docs/content/design-guidelines/) + +Local design guidelines provided by PatternFly team for this extension. + +**Added by**: Initial setup | **Date**: 2026-03-18 | **Note**: Authoritative source for UX patterns + +--- + +## Development Resources + +### [Component Examples (Local)](./packages/module/patternfly-docs/content/examples/) + +Live code examples and markdown documentation for all components in this extension. + +**Added by**: Initial setup | **Date**: 2026-03-18 | **Note**: Start with URL.tsx for basic usage + +--- + +**Tip**: Use `/bookmark ` in Ambient to add to this list collaboratively with your team. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..b158b61 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,52 @@ +# react-user-feedback + +A React component library for collecting user feedback via a form in a modal. Built with React, TypeScript, PatternFly, and Webpack. + +## Structure + +- `/packages/module/src/Feedback` - React components specific to this PatternFly extension +- `/packages/module/patternfly-docs/content/examples/` - MD files and live code examples for API documentation +- `/packages/module/patternfly-docs/content/design-guidelines/` - Design guidelines from PatternFly for this extension + +## Key Files + +- Monorepo root: `/package.json` +- Library package: `/packages/module/package.json` +- Setup instructions: `/README.md` +- Custom styling: `/packages/module/src/Feedback/Feedback.css` +- Usage entry point: `/packages/module/patternfly-docs/content/examples/URL.tsx` + +## Commands + +```bash +yarn build # Build the library +yarn test # Run tests (currently disabled) +yarn lint # Lint the codebase +``` + +For accessibility testing: +```bash +yarn build:docs && yarn serve:docs # Start docs server +yarn test:a11y # Run a11y tests (in separate terminal) +``` + +## Important Context + +- **Use PatternFly 6 components** - no inline styles, minimal custom styles +- **Do NOT use TailwindCSS** - this uses PatternFly design system +- PatternFly MCP available for development rules and docs: + ```json + { + "mcpServers": { + "patternfly-docs": { + "command": "npx", + "args": ["-y", "@patternfly/patternfly-mcp"], + "description": "PatternFly React development rules and documentation" + } + } + } + ``` + +## More Info + +See [BOOKMARKS.md](BOOKMARKS.md) for PatternFly documentation, design guidelines, and contribution resources.