From ff6ed47df6a1f1323b07bd5794720b4d436f1c84 Mon Sep 17 00:00:00 2001 From: nicolethoen Date: Wed, 18 Mar 2026 17:40:27 -0400 Subject: [PATCH] chore: add agentic guidance --- BOOKMARKS.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ CLAUDE.md | 39 +++++++++++++++++++++++++++++++++++++ 2 files changed, 93 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..772c006 --- /dev/null +++ b/BOOKMARKS.md @@ -0,0 +1,54 @@ +# Bookmarks + +Progressive disclosure for task-specific documentation and references. + +## Table of Contents +- [PatternFly Documentation](#patternfly-documentation) +- [Virtualization & Performance](#virtualization--performance) +- [Development Resources](#development-resources) + +--- + +## PatternFly Documentation + +### [PatternFly 6 React Docs](https://www.patternfly.org/v6/) + +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 + +--- + +## Virtualization & Performance + +### [react-window Documentation](https://react-window.vercel.app/) + +Original react-window library - basis for our fork with custom virtualization needs. + +**Added by**: Initial setup | **Date**: 2026-03-18 | **Note**: We maintain a fork in packages/module/src/react-window/ + +### [react-window GitHub](https://github.com/bvaughn/react-window) + +Source repository for react-window - useful for understanding virtualization patterns and updates. + +**Added by**: Initial setup | **Date**: 2026-03-18 + +--- + +## Development Resources + +### [Log Viewer Documentation (Local)](./packages/module/patternfly-docs/content/extensions/react-log-viewer/) + +Local documentation with examples, design guidelines, and usage patterns for the log viewer. + +**Added by**: Initial setup | **Date**: 2026-03-18 + +--- + +**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..6617df8 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,39 @@ +# react-log-viewer + +A virtualized React component for viewing, searching, and filtering application logs. Built with React, TypeScript, PatternFly, Webpack, and memoize-one (for virtualization). + +## Structure + +- `packages/module/src/react-window/` - Forked react-window for custom virtualization +- `packages/module/src/LogViewer/` - Log viewer components and custom CSS (additional to PatternFly) +- `packages/module/patternfly-docs/content/extensions/react-log-viewer/` - MD files, live code examples, design guidelines, and documentation content + +## Key Files + +- Library package: `packages/module/package.json` +- Setup instructions: `/README.md` +- Main component: `packages/module/src/LogViewer/LogViewer.tsx` +- Monorepo root: `package.json` + +## Commands + +```bash +yarn build # Build the library +yarn test # Run unit tests +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 + +- **Uses forked react-window** for custom virtualization needs +- **Large log files require virtualization** - performance is critical for handling large datasets + +## More Info + +See [BOOKMARKS.md](BOOKMARKS.md) for react-window, virtualization, and PatternFly documentation.