Skip to content

Commit 1038753

Browse files
magicalyakmagicalyak
committed
docs: add CURSOR_CONTEXT.md for comprehensive documentation and update .gitignore
1 parent 2666423 commit 1038753

File tree

3 files changed

+665
-1
lines changed

3 files changed

+665
-1
lines changed

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
docs/images/.DS_Store
22
.DS_Store
3-
venv/
3+
venv/
4+
scratch/

‎CURSOR_CONTEXT.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# CURSOR_CONTEXT.md
2+
3+
## Repository Overview
4+
5+
This repository (`console-docs`) contains the commercial/enterprise documentation for NetBox Labs' products and services. It serves as one component of the unified NetBox documentation ecosystem that powers the official documentation site at https://netboxlabs.com/docs.
6+
7+
## Documentation Architecture
8+
9+
The NetBox documentation ecosystem consists of multiple repositories that are combined to create a comprehensive documentation hub:
10+
11+
### Repository Structure
12+
- **`netboxlabs/netbox`**: Contains the core NetBox open-source documentation (community docs)
13+
- **`netboxlabs/console-docs`** (this repo): Contains commercial/enterprise product documentation
14+
- **`netboxlabs/netboxlabs-website-dochub`**: The deployment/integration repository that combines both documentation sources
15+
16+
### Content Organization
17+
18+
This repository contains documentation for NetBox Labs' commercial offerings:
19+
20+
#### Core Sections
21+
- **Administration Console/**: NetBox Cloud administration interface documentation
22+
- **NetBox Cloud/**: Cloud-hosted NetBox service documentation
23+
- **netbox-enterprise/**: Enterprise edition features and configuration
24+
- **netbox-assurance/**: Network assurance and monitoring capabilities
25+
- **netbox-discovery/**: Automated network discovery features
26+
- **netbox-extensions/**: Advanced features like branching, changes tracking, and diode
27+
- **netbox-integrations/**: Third-party service integrations (ServiceNow, etc.)
28+
- **cloud-connectivity/**: Cloud connectivity and networking documentation
29+
- **sdks/**: Software development kits and API documentation
30+
31+
#### Supporting Content
32+
- **images/**: Screenshots, diagrams, and visual assets organized by feature
33+
- **stylesheets/**: Custom styling for documentation presentation
34+
35+
## Integration Process
36+
37+
The documentation deployment process works as follows:
38+
39+
1. **Content Sources**:
40+
- Community docs from `netboxlabs/netbox` repository
41+
- Commercial docs from this repository (`netboxlabs/console-docs`)
42+
43+
2. **Integration Hub**:
44+
- `netboxlabs/netboxlabs-website-dochub` repository combines both sources
45+
- Handles navigation structure, cross-references, and unified presentation
46+
47+
3. **Deployment**:
48+
- Combined documentation is deployed to https://netboxlabs.com/docs
49+
- Provides seamless experience between community and commercial documentation
50+
51+
## Build & Deployment Pipeline
52+
53+
The `netboxlabs-website-dochub` repository handles the technical build and deployment process:
54+
55+
### Build Technology
56+
- **Framework**: Uses Docusaurus for static site generation
57+
- **Package Manager**: yarn for dependency management and build orchestration
58+
- **Source Integration**: Combines content from both community and commercial documentation repositories
59+
60+
### Deployment Workflow
61+
1. **Preview Environment**: Changes are previewed in Vercel before production deployment
62+
2. **Production Pipeline**: Built site is pushed to production hosting
63+
3. **Automatic Integration**: **(Unverified)** Merges to this repository should automatically trigger the production pipeline, but this process has not been fully verified yet
64+
65+
### Integration Status
66+
- **Current State**: Manual verification may be required for production deployments
67+
- **Intended Behavior**: Automatic merge-to-production workflow from this repository
68+
- **Status**: Integration pipeline verification is pending
69+
70+
## Documentation Technology
71+
72+
- **Framework**: Built using MkDocs (configured in `mkdocs.yml`)
73+
- **Content Format**: Markdown files with MkDocs extensions
74+
- **Styling**: Custom CSS in `stylesheets/` directory
75+
- **Assets**: Images and media files organized by feature/product
76+
77+
## Key Considerations for Development
78+
79+
### Content Strategy
80+
- **Audience Separation**: Clear distinction between community (open-source) and commercial content
81+
- **Feature Parity**: Commercial docs should complement, not duplicate, community documentation
82+
- **Cross-References**: Links between community and commercial docs should work seamlessly
83+
84+
### File Organization
85+
- Keep related images in corresponding subdirectories under `docs/images/`
86+
- Maintain consistent naming conventions across features
87+
- Organize content hierarchically to match product structure
88+
89+
### Integration Points
90+
- Navigation structure must align with the combined documentation site
91+
- Cross-references to community docs should use appropriate linking strategies
92+
- Consider how content will appear in the unified search experience
93+
94+
## Development Workflow
95+
96+
When working on this repository:
97+
98+
1. **Local Development**: Use MkDocs for local preview and testing
99+
2. **Content Changes**: Focus on commercial/enterprise features and capabilities
100+
3. **Asset Management**: Ensure images are optimized and properly organized
101+
4. **Integration Testing**: Consider how changes will appear in the combined documentation site
102+
5. **Deployment Verification**: Monitor the automatic deployment process (when fully verified)
103+
104+
## Related Resources
105+
106+
- **Main Documentation Site**: https://netboxlabs.com/docs
107+
- **NetBox Community Docs**: Part of the `netboxlabs/netbox` repository
108+
- **Integration Repository**: `netboxlabs/netboxlabs-website-dochub`
109+
- **NetBox GitHub**: https://github.com/netbox-community/netbox (referenced in web content)
110+
111+
## Purpose Statement
112+
113+
This repository ensures that NetBox Labs' commercial customers have comprehensive, well-organized documentation for enterprise features while maintaining the unified experience with community documentation that makes NetBox the premier network source of truth solution.

0 commit comments

Comments
 (0)