How to Use This Vault

How to Use This Documentation

This documentation is organized using Obsidian, a powerful knowledge base that works on top of a local folder of Markdown files. This guide will help you navigate and contribute to the documentation effectively.

Documentation Structure

The Nimbly Compass documentation contains these main folders:

• Index - Starting point and guides like this one and the Quick Start Guide
• User Roles - Role-based documentation with User Roles
• Features - Feature documentation with Features
• Platforms - Platform-specific information

Navigation Methods

Using the File Explorer

Navigate through the folder structure to find relevant documentation. Each section has an overview document that links to more specific content.

Using Internal Links

All documents are connected through internal links. You can:

• Click on any link to navigate directly to that document
• Hover over links to preview content
• Use the back button to return to previous pages

Using the Graph View

The Graph View shows connections between documents and is particularly useful for understanding relationships:

1. Click the “Open graph view” button in Obsidian’s sidebar
2. Explore relationships between documents visually
3. Click on nodes to navigate to documents

User Roles Documentation

The User Roles directory contains documentation specific to each user role:

• User Roles - Main overview of all roles
• Individual role documentation:
  • Account Holder
  • Admin
  • Supervisor
  • Auditor
  • LMS Admin
  • Learner

Features Documentation

The Features directory contains documentation for each Nimbly feature, with:

• Features - Main overview of all features
• Individual feature folders containing user guides and implementation details

Using Tags

Tags provide another way to organize and find information:

Main Tag Categories

• #connects/role - Shows connection to user roles
• #connects/platform - Shows connection to platforms
• #connects/feature - Shows connection to features

Click on any tag to see all documents with that tag.

Contributing to Documentation

When adding new content:

1. Follow the established naming convention (kebab-case for files)
2. Add appropriate tags consistent with the tagging strategy
3. Create links to related documents
4. Place the file in the appropriate folder

Tips for Effective Documentation Use

1. Start with overview documents: Begin with the overview file for each section
2. Use the search function: Press Ctrl+F or Cmd+F to search within a document
3. Use global search: Press Ctrl+Shift+F or Cmd+Shift+F to search across all documents
4. Filter by tags: Use tags to find related content across the documentation
5. Use the graph view: Visualize connections between documents