Skip to content

Commit 5a8a3d4

Browse files
authored
chore: add agentic guidance (#111)
1 parent 60b20e4 commit 5a8a3d4

2 files changed

Lines changed: 81 additions & 0 deletions

File tree

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+
- [Console Technologies](#console-technologies)
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+
## Console Technologies
29+
30+
### [noVNC Documentation](https://novnc.com/info.html)
31+
32+
VNC client using HTML5 (WebSockets, Canvas) - powers the VncConsole component.
33+
34+
**Added by**: Initial setup | **Date**: 2026-03-18 | **Note**: Core dependency for remote display
35+
36+
### [XTerm.js Documentation](https://xtermjs.org/)
37+
38+
Terminal emulator library for the web - powers the SerialConsole component.
39+
40+
**Added by**: Initial setup | **Date**: 2026-03-18
41+
42+
---
43+
44+
## Development Resources
45+
46+
### [Component Examples (Local)](./packages/module/patternfly-docs/content/extensions/react-console/examples/)
47+
48+
Live code examples and markdown documentation for console components.
49+
50+
**Added by**: Initial setup | **Date**: 2026-03-18 | **Note**: Start with SerialConsoleCustom.jsx
51+
52+
---
53+
54+
**Tip**: Use `/bookmark <url> <description>` in Ambient to add to this list collaboratively with your team.

CLAUDE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# react-console
2+
3+
React components for accessing virtual machine or server consoles. Provides VncConsole, SerialConsole, and DesktopViewer components built with PatternFly. Built with React, TypeScript, PatternFly, Webpack, noVNC, and XTerm.
4+
5+
## Structure
6+
7+
- `packages/module/src/components/` - Console component implementations
8+
- `/packages/module/patternfly-docs/content/extensions/react-console/examples/` - MD files and live code examples for documentation
9+
10+
## Key Files
11+
12+
- Setup instructions: `README.md`
13+
- Library package: `packages/module/package.json`
14+
- Monorepo root: `package.json`
15+
- Usage entry point: `packages/module/patternfly-docs/content/extensions/react-console/examples/SerialConsoleCustom.jsx`
16+
17+
## Commands
18+
19+
```bash
20+
yarn build # Build the library
21+
yarn test # Run tests
22+
yarn lint # Lint the codebase
23+
```
24+
25+
## More Info
26+
27+
See [BOOKMARKS.md](BOOKMARKS.md) for noVNC, XTerm, and PatternFly documentation.

0 commit comments

Comments
 (0)