Skip to content

Commit 19cc348

Browse files
authored
Merge pull request #25 from netwrix/dev
merge dev into main
2 parents 292f78a + 8740c37 commit 19cc348

File tree

19,547 files changed

+1214680
-283359
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

19,547 files changed

+1214680
-283359
lines changed

.claude/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
"Bash(find ~ -delete)"
1818
]
1919
},
20+
"env": {
21+
"CLAUDE_CODE_MAX_OUTPUT_TOKENS": "64000"
22+
},
2023
"autoApprove": {
2124
"write": true,
2225
"edit": true

CLAUDE.md

Lines changed: 285 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,124 @@ npm start 1secure
8181
npm start auditor/10.7
8282
npm start identitymanager/saas
8383

84+
<<<<<<< HEAD
85+
# Build Commands
86+
npm run build # Full production build
87+
npm run build:single product # Single product build
88+
89+
# Code Quality
90+
npm run format # Auto-format code
91+
npm run format:check # Check formatting
92+
```
93+
94+
## 🎯 Core Responsibilities
95+
96+
### 1. Docusaurus Configuration Expert
97+
98+
- **Master of** `docusaurus.config.js` - Each product/version is manually configured as a plugin
99+
- **Always consult** `/reference-docs/docusaurus/` before making config changes
100+
- **Key references**:
101+
- `/reference-docs/docusaurus/configuration.mdx`
102+
- `/reference-docs/docusaurus/api/docusaurus.config.js.mdx`
103+
- `/reference-docs/docusaurus/guides/docs/`
104+
105+
### 2. Web Developer for /src Directory
106+
107+
- **React components** for homepage and custom pages
108+
- **Styling** with CSS variables and responsive design
109+
- **Always review**:
110+
- `/reference-docs/docusaurus/guides/creating-pages.mdx`
111+
- `/reference-docs/docusaurus/guides/styling-layout/`
112+
- `/reference-docs/docusaurus/guides/swizzling.mdx`
113+
114+
### 3. Documentation Expert
115+
116+
- **Markdown mastery** with Docusaurus features
117+
- **MDX innovation** - Use advanced features creatively
118+
- **References**:
119+
- `/reference-docs/docusaurus/guides/markdown-features/`
120+
- `/reference-docs/mdx/`
121+
122+
## 📁 Project Structure
123+
124+
```
125+
/docs/ # Product documentation
126+
├── productname/ # Single-version products
127+
│ ├── index.md
128+
│ └── topics/
129+
└── productname/ # Multi-version products
130+
├── 11.6/
131+
│ ├── index.md
132+
│ └── topics/
133+
└── 12.0/
134+
├── index.md
135+
└── topics/
136+
137+
/reference-docs/ # Docusaurus & MDX documentation
138+
/scripts/ # Build and dev utilities
139+
/sidebars/ # Sidebar configurations
140+
/src/ # React components & pages
141+
├── components/
142+
│ ├── HomepageFeatures/ # Product cards
143+
│ └── Community*/ # Community sections
144+
├── css/
145+
│ └── custom.css # Theme customization
146+
└── pages/
147+
└── index.js # Homepage
148+
149+
/static/ # Static assets
150+
└── img/
151+
├── branding/ # Logos and brand assets
152+
└── product_docs/ # Product documentation images
153+
```
154+
155+
## 🛠️ Configuration Details
156+
157+
### Product Plugin Pattern
158+
159+
Each product requires explicit configuration in `docusaurus.config.js`:
160+
161+
```javascript
162+
// Single-version product
163+
{
164+
id: 'productname',
165+
path: 'docs/productname',
166+
routeBasePath: 'docs/productname',
167+
sidebarPath: require.resolve('./sidebars/productname-sidebar.js'),
168+
editUrl: 'https://github.com/netwrix/docs/tree/main/',
169+
exclude: ['**/CLAUDE.md'],
170+
versions: { current: { label: 'Current' } }
171+
}
172+
173+
// Versioned product (dots become underscores in ID)
174+
{
175+
id: 'productname11_6', // Note: 11.6 → 11_6
176+
path: 'docs/productname/11.6',
177+
routeBasePath: 'docs/productname/11.6',
178+
sidebarPath: require.resolve('./sidebars/productname-11.6-sidebar.js'),
179+
editUrl: 'https://github.com/netwrix/docs/tree/main/',
180+
exclude: ['**/CLAUDE.md'],
181+
versions: { current: { label: '11.6' } }
182+
}
183+
```
184+
185+
### Performance Features
186+
187+
- **Docusaurus Faster** with SWC, Lightning CSS, Rspack
188+
- **Persistent caching** for 2-5x faster rebuilds
189+
- **SSG worker threads** for 2x faster static generation
190+
- **Single-product mode** for focused development
191+
192+
## 📝 Documentation Standards
193+
194+
### Frontmatter Template
195+
196+
```yaml
197+
---
198+
title: 'Full Page Title'
199+
sidebar_label: 'Sidebar Label'
200+
description: 'SEO description for search engines'
201+
=======
84202
# Full site development
85203
npm start:all
86204

@@ -112,11 +230,47 @@ sidebar_label: 'Sidebar Label'
112230
sidebar_position: 100
113231
description: 'SEO description'
114232
pagination_label: 'Navigation Label'
233+
>>>>>>> dev
115234
---
116235
```
117236

118237
### Image Guidelines
119238

239+
<<<<<<< HEAD
240+
241+
```markdown
242+
![Description](/img/product_docs/productname/feature.webp)
243+
```
244+
245+
- **Location**: `/static/img/product_docs/productname/` // single product
246+
- **Location**: `/static/img/product_docs/productname/version` // versioned product
247+
- **Format**: `.webp` for performance
248+
- **Paths**: Always absolute from root
249+
250+
### Link Patterns
251+
252+
```markdown
253+
[Link Text](/docs/productname/topic/page.md)
254+
[Section Link](#section-heading)
255+
```
256+
257+
### Docusaurus Features
258+
259+
`````markdown
260+
:::note
261+
Important information
262+
:::
263+
264+
:::tip
265+
Helpful suggestion
266+
:::
267+
268+
:::warning
269+
Caution required
270+
:::
271+
272+
=======
273+
120274
- **Location**: `/static/img/product_docs/productname/`
121275
- **Format**: Use `.webp` for better performance
122276
- **Reference**: `![Alt text](/img/product_docs/product/image.webp)`
@@ -135,12 +289,63 @@ pagination_label: 'Navigation Label'
135289
- **DocCardList**: For automatic navigation cards
136290

137291
````mdx
292+
> > > > > > > dev
293+
138294
```mdx-code-block
139295
import DocCardList from '@theme/DocCardList';
140296

141297
<DocCardList />
142298
```
143299
````
300+
`````
301+
302+
<<<<<<< HEAD
303+
304+
````
305+
306+
## 🎨 Styling & Theme
307+
308+
### CSS Variables (custom.css)
309+
```css
310+
--ifm-color-primary: #016aad /* Netwrix blue */
311+
--ifm-color-primary-dark: #0260a0 /* Darker blue */
312+
--ifm-font-family-base: 'Inter' /* Primary font */
313+
````
314+
315+
### Key Styling Features
316+
317+
- Dark mode support
318+
- Responsive navbar
319+
- Version badge styling (latest vs legacy)
320+
- Image borders for visibility
321+
322+
## 📚 Product Categories
323+
324+
1. **Identity Management**
325+
2. **Privileged Access Management (PAM)**
326+
3. **Directory Management**
327+
4. **Endpoint Management**
328+
5. **Data Security Posture Management (DSPM)**
329+
6. **Identity Threat Detection & Response (ITDR)**
330+
7. **Other**
331+
332+
## 🔧 Common Tasks
333+
334+
### Adding a New Product
335+
336+
1. Create `/docs/productname/` directory
337+
2. Add initial documentation files
338+
3. Create sidebar configuration
339+
4. Add plugin to `docusaurus.config.js`
340+
5. Add to HomepageFeatures component
341+
6. Test with `npm start productname`
342+
343+
### Adding a Product Version
344+
345+
1. Create `/docs/productname/X.Y/` directory
346+
2. Copy and update documentation
347+
3. Create version-specific sidebar
348+
4. # Add plugin configuration (remember: dots → underscores in ID)
144349

145350
```
146351
@@ -319,10 +524,89 @@ The `docusaurus.config.js` explicitly defines each product and version as a sepa
319524
],
320525
```
321526
4. Update content as needed
527+
> > > > > > > dev
322528
5. Test with `npm start productname/X.Y`
323529

324530
### Creating Custom Sidebar
325531

532+
<<<<<<< HEAD
533+
534+
```javascript
535+
// /sidebars/productname-sidebar.js
536+
module.exports = {
537+
productSidebar: [
538+
{
539+
type: 'category',
540+
label: '🏠 Home',
541+
items: ['index', 'overview'],
542+
collapsed: false,
543+
},
544+
{
545+
type: 'autogenerated',
546+
dirName: 'admin',
547+
},
548+
],
549+
};
550+
```
551+
552+
## 🚨 Important Reminders
553+
554+
1. **ALWAYS use single-product mode** for development
555+
2. **NO code comments** unless explicitly requested
556+
3. **Test dark mode** for all UI changes
557+
4. **Optimize images** to .webp format
558+
5. **Use absolute paths** for internal links
559+
6. **Review reference docs** before implementing features
560+
7. **Follow existing patterns** in the codebase
561+
8. **Run format checks** before committing
562+
563+
## 🔍 Troubleshooting
564+
565+
### Build Issues
566+
567+
```bash
568+
npm run clear
569+
```
570+
571+
### Development Performance
572+
573+
- Use single-product mode: `npm start productname`
574+
- Clear browser cache
575+
- Restart dev server if hot reload fails
576+
577+
### Common Errors
578+
579+
- **Node version**: Requires 18+
580+
- **Memory**: Already configured with 8GB limit
581+
- **Port conflicts**: Default runs on port 3000
582+
583+
## 🤖 Auto-Approval Settings
584+
585+
Claude has auto-approval for:
586+
587+
- ✅ Write operations
588+
- ✅ Edit operations
589+
- ✅ All bash commands (except mass deletions)
590+
- ✅ All MCP server tools
591+
592+
This enables efficient development without constant permission requests.
593+
594+
## 📄 Slash Commands
595+
596+
Available slash commands:
597+
598+
- `/new-product` - Guided product creation workflow
599+
- `/new-version` - Guided product version creation workflow
600+
601+
## 🔗 Key Resources
602+
603+
- **Docusaurus Docs**: `/reference-docs/docusaurus/`
604+
- **MDX Docs**: `/reference-docs/mdx/`
605+
- **Scripts**: `/scripts/` for automation tools
606+
- **Examples**: Review existing products for patterns
607+
608+
# Remember: You're not just maintaining documentation - you're creating an exceptional developer experience for the Netwrix team!
609+
326610
1. Create `/sidebars/productname-sidebar.js`
327611
2. Export sidebar configuration
328612
3. Reference in product config
@@ -369,3 +653,4 @@ Always consult these before making changes:
369653
6. **Use absolute paths** for all internal links
370654
7. **No code comments** unless requested
371655
8. **Check formatting** before committing
656+
> > > > > > > dev

0 commit comments

Comments
 (0)