Skip to content

Commit ece67ce

Browse files
committed
chore: add agentic guidance
1 parent a18f1ce commit ece67ce

File tree

2 files changed

+93
-0
lines changed

2 files changed

+93
-0
lines changed

BOOKMARKS.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Bookmarks
2+
3+
Progressive disclosure for task-specific documentation and references.
4+
5+
## Table of Contents
6+
- [PatternFly Documentation](#patternfly-documentation)
7+
- [Virtualization & Performance](#virtualization--performance)
8+
- [Development Resources](#development-resources)
9+
10+
---
11+
12+
## PatternFly Documentation
13+
14+
### [PatternFly 6 React Docs](https://www.patternfly.org/v6/)
15+
16+
Official PatternFly 6 React component documentation and API reference.
17+
18+
**Added by**: Initial setup | **Date**: 2026-03-18
19+
20+
### [PatternFly MCP Server](https://www.npmjs.com/package/@patternfly/patternfly-mcp)
21+
22+
MCP server for PatternFly development rules and documentation - use with Ambient/Claude for inline guidance.
23+
24+
**Added by**: Initial setup | **Date**: 2026-03-18
25+
26+
---
27+
28+
## Virtualization & Performance
29+
30+
### [react-window Documentation](https://react-window.vercel.app/)
31+
32+
Original react-window library - basis for our fork with custom virtualization needs.
33+
34+
**Added by**: Initial setup | **Date**: 2026-03-18 | **Note**: We maintain a fork in packages/module/src/react-window/
35+
36+
### [react-window GitHub](https://github.com/bvaughn/react-window)
37+
38+
Source repository for react-window - useful for understanding virtualization patterns and updates.
39+
40+
**Added by**: Initial setup | **Date**: 2026-03-18
41+
42+
---
43+
44+
## Development Resources
45+
46+
### [Log Viewer Documentation (Local)](./packages/module/patternfly-docs/content/extensions/react-log-viewer/)
47+
48+
Local documentation with examples, design guidelines, and usage patterns for the log viewer.
49+
50+
**Added by**: Initial setup | **Date**: 2026-03-18
51+
52+
---
53+
54+
**Tip**: Use `/bookmark <url> <description>` in Ambient to add to this list collaboratively with your team.

CLAUDE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# react-log-viewer
2+
3+
A virtualized React component for viewing, searching, and filtering application logs. Built with React, TypeScript, PatternFly, Webpack, and memoize-one (for virtualization).
4+
5+
## Structure
6+
7+
- `packages/module/src/react-window/` - Forked react-window for custom virtualization
8+
- `packages/module/src/LogViewer/` - Log viewer components and custom CSS (additional to PatternFly)
9+
- `packages/module/patternfly-docs/content/extensions/react-log-viewer/` - MD files, live code examples, design guidelines, and documentation content
10+
11+
## Key Files
12+
13+
- Library package: `packages/module/package.json`
14+
- Setup instructions: `/README.md`
15+
- Main component: `packages/module/src/LogViewer/LogViewer.tsx`
16+
- Monorepo root: `package.json`
17+
18+
## Commands
19+
20+
```bash
21+
yarn build # Build the library
22+
yarn test # Run unit tests
23+
yarn lint # Lint the codebase
24+
```
25+
26+
For accessibility testing:
27+
```bash
28+
yarn build:docs && yarn serve:docs # Start docs server
29+
yarn test:a11y # Run a11y tests (in separate terminal)
30+
```
31+
32+
## Important Context
33+
34+
- **Uses forked react-window** for custom virtualization needs
35+
- **Large log files require virtualization** - performance is critical for handling large datasets
36+
37+
## More Info
38+
39+
See [BOOKMARKS.md](BOOKMARKS.md) for react-window, virtualization, and PatternFly documentation.

0 commit comments

Comments
 (0)