Skip to content

Commit a8d71c6

Browse files
committed
updated docs
1 parent 5ea8be0 commit a8d71c6

File tree

23,075 files changed

+38065
-34443
lines changed

Some content is hidden

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

23,075 files changed

+38065
-34443
lines changed

CLAUDE.md.bak

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
Surgical Documentation Consolidation Project
2+
3+
You are tasked with performing a surgical consolidation of Netwrix documentation to improve user experience while preserving 100% of existing knowledge. This is a
4+
precision operation - never delete content, only reorganize and consolidate.
5+
6+
Core Principles
7+
8+
1. Zero Knowledge Loss: Every piece of information must be preserved somewhere in the final structure
9+
2. Surgical Precision: Only consolidate files that are genuinely redundant or provide poor user experience
10+
3. Conservative Approach: When in doubt, preserve the existing structure
11+
4. Content Migration: Move content to logical locations, don't create new content
12+
5. Link Preservation: Update all internal links after any file moves/consolidations
13+
14+
Specific Consolidation Targets
15+
16+
Priority 1: Empty Landing Pages (31 files)
17+
18+
Target Files: All /docs/*/index.md files containing only product titles (e.g., "# Access Analyzer")
19+
20+
Action: Replace with consolidated content by moving (not rewriting) the best existing content from:
21+
- /docs/*/product-name/overview.md
22+
- /docs/*/product-name/gettingstarted.md
23+
- /docs/*/welcome.md (e.g. StrongPoint products)
24+
- /docs/*/index.md
25+
- /docs/*/faq.md
26+
- /docs/*/navigating*.md
27+
- /docs/*/what*.md
28+
29+
If none of the above are present, do a deep analysis on the docs for that product and write a short Overview of that product/its docs.
30+
31+
Process:
32+
1. Read the empty index.md file
33+
2. Locate the best existing overview/getting started content in subdirectories
34+
3. Copy that content to create a comprehensive landing page
35+
4. Preserve the original detailed files - don't delete them
36+
5. Add clear navigation links to detailed documentation
37+
38+
Template Structure (using existing content):
39+
# [Product Name]
40+
41+
[Copy existing product description from overview.md]
42+
43+
## What [Product] Does
44+
[Copy key capabilities from existing overview]
45+
46+
## Getting Started
47+
[Copy essential steps from existing gettingstarted.md]
48+
49+
## Key Resources
50+
- [Installation Guide](install/)
51+
- [Configuration](config/)
52+
- [Complete Documentation](product-name/overview.md)
53+
54+
Priority 2: UserCube Placeholder Files (287 files)
55+
56+
Target Files: Files containing "The documentation is not yet available for this page and will be completed in the near future."
57+
58+
Action: Delete only files that contain exclusively placeholder text with no actual documentation value.
59+
60+
Verification Process:
61+
1. Search for files containing placeholder text patterns
62+
2. Read each file to confirm it contains ONLY placeholder content
63+
3. Create a list of confirmed placeholder files
64+
4. Remove only files that are 100% placeholder content
65+
5. Clean up empty directories left behind
66+
6. Do not touch any files that contain actual documentation mixed with placeholder text
67+
68+
Priority 3: Identical "What's New" Files (15 files)
69+
70+
Target Files: Files with identical community forum redirects
71+
72+
Action:
73+
- Option A: Create a shared component/template that all products reference
74+
- Option B: Consolidate into main product landing pages as a "What's New" section
75+
- Option C: Create a single site-wide "What's New" page with product sections
76+
77+
Process:
78+
1. Identify all identical "What's New" files
79+
2. Preserve the redirect functionality
80+
3. Choose consolidation approach based on existing site patterns
81+
4. Update links to point to consolidated location
82+
83+
Priority 4: PolicyPak Video Documentation (513 → ~50 files)
84+
85+
Target Files: Single-line video title files in /docs/policypak/policypak/video/
86+
87+
Action: Consolidate into topic-based index pages
88+
89+
Process:
90+
1. Group videos by topic/directory structure
91+
2. Create comprehensive index pages for each topic area
92+
3. Preserve all video titles - just organize them into lists within index pages
93+
4. Don't delete individual video files that have substantial content (>10 lines)
94+
5. Update navigation to point to consolidated topic pages
95+
96+
Example Consolidation:
97+
# Application Settings Videos
98+
99+
## Password Security
100+
- [Netwrix Endpoint Policy Manager can manage Netwrix Password Secure](passwordsecure.md)
101+
- [Advanced Password Policy Configuration](advanced-password.md)
102+
103+
## Internet Explorer Settings
104+
- [Browser Security Configuration](ie-security.md)
105+
- [Proxy Settings Management](ie-proxy.md)
106+
107+
Implementation Guidelines
108+
109+
File Operations
110+
111+
- MOVE, don't rewrite: Use existing content wherever possible
112+
- COPY, don't cut: When consolidating, copy content to new location before removing original
113+
- PRESERVE structure: Maintain existing directory hierarchies where logical
114+
- UPDATE links: After any move, update all internal references
115+
116+
Content Handling
117+
118+
- Preserve technical accuracy: Don't paraphrase or rewrite technical information
119+
- Maintain formatting: Keep existing markdown formatting, code blocks, tables
120+
- Preserve metadata: Keep any frontmatter, tags, or metadata
121+
- Respect context: Don't move content if it would lose important context
122+
123+
Quality Assurance
124+
125+
- Link checking: After each consolidation, verify all internal links still work
126+
- Content verification: Compare before/after to ensure no information loss
127+
- Navigation testing: Ensure users can still find all information
128+
- Backup strategy: Work on branches and create checkpoints
129+
130+
Verification Checklist
131+
132+
Before consolidating any file, verify:
133+
- The target file contains redundant or poor-quality content
134+
- The content being moved/consolidated exists elsewhere or provides genuine value
135+
- All internal links pointing to the file are identified
136+
- The consolidation improves user experience without losing functionality
137+
- The new structure maintains logical information architecture
138+
139+
Red Flags - Do NOT Consolidate If:
140+
141+
- File contains unique technical information not found elsewhere
142+
- Content is referenced by external documentation or systems
143+
- File serves as a specific landing page for deep-linked content
144+
- Consolidation would break existing user workflows
145+
- Content has specific versioning or historical significance
146+
- File contains complex tables, diagrams, or structured data that would be diluted
147+
148+
Post-Consolidation Tasks
149+
150+
1. Update internal links: Search for and update all references to moved files
151+
2. Update navigation: Modify sidebar configurations if needed
152+
3. Test user paths: Verify common user workflows still function
153+
4. Document changes: Create a summary of what was consolidated for future reference
154+
155+
Success Metrics
156+
157+
- File count reduction: Target 40-50% reduction in files ≤20 lines
158+
- Zero broken links: All internal navigation must continue working
159+
- Improved landing pages: All products have substantial index pages
160+
- Enhanced discoverability: Users can find information more easily
161+
- Preserved knowledge: 100% of original information remains accessible
162+
163+
Emergency Protocol
164+
165+
If any consolidation results in:
166+
- Broken critical user workflows
167+
- Loss of important information
168+
- Significant user confusion
169+
170+
Immediately: Revert the specific change and document the issue for review.

HOMEPAGE_MODERNIZATION_TASKS.md

Lines changed: 0 additions & 210 deletions
This file was deleted.

TODO.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[ ] Changes all "steps" to markdown ordered lists
2+
[ ] Change all common html markup to markdown versions (bold, underline, etc.)
3+
4+
5+
# Updating a product directory
6+
[ ] Update product name
7+
[ ] Flatten directories for duplicate names

0 commit comments

Comments
 (0)