Using This Site
Using This Site
Section titled “Using This Site”This documentation site is designed to help you quickly find the information you need about NEURO. Here’s how to navigate and use it effectively.
Site Navigation
Section titled “Site Navigation”Sidebar
Section titled “Sidebar”The left sidebar contains the main documentation structure organized by topic:
- Getting Started - New user guides and setup
- Platform Modules - Core feature documentation
- AI Features - AI assistant and automation
- Integrations - Tool imports and API
- Collaboration - Team features
- Administration - Admin settings
- User Settings - Personal preferences
- API Reference - Developer documentation
- Resources - FAQ, support, release notes
Breadcrumbs
Section titled “Breadcrumbs”At the top of each page, breadcrumbs show your current location and allow quick navigation to parent sections.
Table of Contents
Section titled “Table of Contents”The right sidebar shows the table of contents for the current page, allowing you to jump to specific sections.
Search
Section titled “Search”Use the search bar at the top of the page to find content across all documentation:
- Click the search icon or press /
- Type your search query
- Use arrow keys to navigate results
- Press Enter to open a result
Page Features
Section titled “Page Features”Code Blocks
Section titled “Code Blocks”Code examples are syntax-highlighted and can be copied with one click:
{ "finding": { "title": "SQL Injection", "severity": "High", "cvss_score": 8.6 }}Callout Boxes
Section titled “Callout Boxes”Important information is highlighted in callout boxes:
Tables
Section titled “Tables”Data is presented in easy-to-read tables:
| Feature | Description | Module |
|---|---|---|
| CVSS Calculator | Interactive scoring | Findings |
| AI Generation | Auto-generate content | Findings |
| Nmap Import | Asset discovery | Integrations |
Step-by-Step Instructions
Section titled “Step-by-Step Instructions”Procedures are presented as numbered steps for easy following.
Accessibility
Section titled “Accessibility”This documentation site supports:
- Keyboard Navigation - Navigate entirely without a mouse
- Screen Readers - Full ARIA label support
- Dark Mode - Toggle in the header for reduced eye strain
- Responsive Design - Works on all device sizes
Feedback
Section titled “Feedback”We continuously improve our documentation. If you:
- Find an error or outdated information
- Have suggestions for improvement
- Need clarification on a topic
Please use the feedback link at the bottom of each page or contact docs@nforged.com.
Exporting Pages
Section titled “Exporting Pages”To save documentation for offline use:
- Navigate to the page you want to export
- Use your browser’s print function (⌘/Ctrl + P)
- Select “Save as PDF” as the destination
Version Information
Section titled “Version Information”Documentation is versioned alongside the NEURO platform. The current version is displayed in the footer. When significant changes occur, we’ll note them in the Release Notes.
Ready to get started? Head to the Quick Start Guide.