Skip to content

MCERQUA/SpatialDocs

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
Generated-Scripts
Generated-Scripts
 
 
Spatial-Examples
Spatial-Examples
 
 
Spatial-SDK-Docs
Spatial-SDK-Docs
 
 
GIT-UPDATE-REPO.bat
GIT-UPDATE-REPO.bat
 
 
README.md
README.md
 
 
git_config.txt
git_config.txt
 
 

Repository files navigation

Spatial SDK Documentation Project

Overview

This repository contains comprehensive documentation for the Spatial Unity SDK interfaces and components. The documentation is organized to provide clear, practical, and thorough coverage of each interface and its related components.

Project Structure

SpatialDocs/
├── docs/
│   ├── PLAN.md                 # Project plan and progress tracking
│   ├── manifest.json           # Main documentation status tracker (now split)
│   ├── manifest-primary.json   # Primary interfaces tracking
│   ├── manifest-completed.json # Completed secondary components tracking
│   ├── manifest-incomplete.json # Incomplete components tracking
│   ├── SESSION_TEMPLATE.md     # Template for documentation sessions
│   ├── SESSIONS_INDEX.md       # Index of all documentation sessions
│   ├── sessions/               # Individual session documentation files
│   │   └── YYYY-MM-DD-Category-Name.md  # Session files by date and category
│   └── README.md               # Project overview
└── research/
    └── reference/              # Interface documentation
        └── SpatialSys/
            └── UnitySDK/       # Interface implementations

CURRENT STATUS AND NEXT TASK

Current Status (Updated 2025-03-10) ✅

  • Primary interfaces (24): 100% complete ✅
  • Secondary components (120): 120/120 completed (100%) ✅
  • Overall completion: 100% ✅

Important Update: Documentation Structure Improvements

  • New Session-Based Manifest System: The project now uses a split manifest structure for better management
  • New Sessions Organization: Individual session files are now stored in the docs/sessions/ directory with an index in SESSIONS_INDEX.md

NEXT CATEGORY TO DOCUMENT

Core Components category is the next to document, continuing with remaining Core Components

To document components:

  1. Use firecrawl_scrape to fetch documentation from toolkit.spatial.io
  2. Create Markdown file in research/reference/SpatialSys/UnitySDK/
  3. Follow documentation template (see Example section below)
  4. Create new session manifest in docs/manifests/
  5. Create session log file in docs/sessions/
  6. Mark as completed in README.md

Documentation Process

Each component is documented in a dedicated session following these steps:

  1. Content gathering from reference
  2. Documentation structure creation
  3. Code examples implementation
  4. Quality review
  5. Progress tracking update
  6. GitHub file upload (after user confirmation)
  7. Update of all tracking files

For a detailed process, see:

Documentation Example

Here's a simplified example of how a secondary component should be documented:

# ComponentName
 
Category: Service Category
 
Interface/Class/Enum: Type
 
Brief description of the component's purpose and functionality.
 
## Properties/Fields (if applicable)
 
| Property | Description |
| --- | --- |
| propertyName | Description of the property |
 
## Methods (if applicable)
 
| Method | Description |
| --- | --- |
| methodName(params) | Description of the method |
 
## Usage Examples
 
```csharp
// Example code showing how to use the component
var example = new ComponentName();
example.DoSomething();

Best Practices

  1. Practice 1
  2. Practice 2

Common Use Cases

  1. Use case 1
  2. Use case 2
 
## Documentation Status
 
### Primary Interfaces (Main Services)
- **Total Primary Interfaces**: 24
- **Completed**: 24 (100%)
- **Remaining**: 0 (0%)
 
### Secondary Components
- **Total Secondary Components**: 120
- **Completed**: 72 (60%)
- **Remaining**: 48 (40%)
 
### Overall Progress
- **Total Components**: 144
- **Overall Completion**: 66.7%
 
See [docs/manifest.json](docs/manifest.json) and its related split files for detailed tracking of components and [Component Checklist](#spatial-sdk-component-documentation-checklist) below for a comprehensive list of all components.
 
## Documentation Standards
Each component documentation must include:
- Component Overview
- Properties/Fields with descriptions (where applicable)
- Methods with parameters (where applicable)
- Events and callbacks (where applicable)
- Usage examples
- Best practices (where applicable)
- Common use cases (where applicable)
 
## Scraping Instructions
 
To get documentation for a component from the Spatial SDK website, use the Firecrawl MCP tool:
 
```javascript
// Use firecrawl_scrape to fetch documentation
firecrawl_scrape({
    url: "https://toolkit.spatial.io/reference/SpatialSys.UnitySDK.[ComponentName]",
    formats: ["markdown"],
    onlyMainContent: true
})

If the component is not available at the main URL, search for related components:

// Search for component references
firecrawl_map({
    url: "https://toolkit.spatial.io/reference",
    search: "[ComponentName]"
})

Session Continuation Instructions

When starting a new documentation session:

  1. Check the "NEXT CATEGORY TO DOCUMENT" section in this README
  2. Review docs/manifest-incomplete.json for priority and categorization
  3. Fetch the component documentation using firecrawl
  4. Create/update the appropriate markdown file
  5. Present the completed documentation for user review
  6. After user confirmation, upload the file to GitHub
  7. Update tracking files after successful upload:
    • Create new session manifest file in docs/manifests/
    • Create session log file in docs/sessions/
    • Update SESSIONS_INDEX.md
    • Update BOTH README.md files (this one and docs/README.md)

Important Process Notes

Repository Structure

  • This repository contains TWO README.md files:
    • This main README.md in the root directory
    • A secondary docs/README.md with project summary information
  • BOTH files must be updated when a component is completed

File Upload Process

  1. Always upload files to GitHub after user confirmation
  2. Upload files in this sequence:
    • Component documentation first
    • Session manifest file second
    • Session log file third
    • README updates (both files) fourth
    • SESSIONS_INDEX.md update last
  3. Always verify uploads are successful

Checkmark and Documentation Links

  • Use proper markdown syntax: - [x] for checkmarks
  • Add links to documentation files: - [x] [ComponentName](./path/to/file.md)
  • Add completion date: - [x] [ComponentName](./path/to/file.md) - COMPLETED! (MM/DD/YYYY)
  • Mark completed categories: #### Category Name (COMPLETED ✅)
  • Always verify checkmarks appear green and links work correctly

Access Information

Troubleshooting

  • If you can't find the component directly, it may be documented as part of another component
  • For event args classes, look for the corresponding event in the parent service
  • If you need to see the implementation, check the EditorSimulation folder in the SDK source
  • When creating examples, prefer complete, practical code over abstract snippets

Remaining Work Estimation

  • Time per component: ~30-60 minutes
  • Average cost per component: $3-5
  • Total remaining work: ~24-48 hours
  • Estimated total cost: $144-240

Spatial SDK Component Documentation Checklist

Main Services (Primary Interfaces)

Component On toolkit.spatial.io In GitHub Repo Status
SpatialBridge ✅ ✅ Documented
IActorService ✅ ✅ Documented
IActor ✅ ✅ Documented
IAvatar ✅ ✅ Documented
IAdService ✅ ✅ Documented
IAudioService ✅ ✅ Documented
IBadgeService ✅ ✅ Documented
ICameraService ✅ ✅ Documented
ICoreGUIService ✅ ✅ Documented
ICoreGUIShopService ✅ ✅ Documented
IEventService ✅ ✅ Documented
IGraphicsService ✅ ✅ Documented
IInputService ✅ ✅ Documented
IInventoryService ✅ ✅ Documented
ILoggingService ✅ ✅ Documented
IMarketplaceService ✅ ✅ Documented
INetworkingService ✅ ✅ Documented
INetworkingRemoteEventsService ✅ ✅ Documented
IQuestService ✅ ✅ Documented
ISpaceContentService ✅ ✅ Documented
ISpaceObject ✅ ✅ Documented
ISpaceService ✅ ✅ Documented
IUserWorldDataStoreService ✅ ✅ Documented
IVFXService ✅ ✅ Documented

Secondary Components (To Be Documented)

Actor Service Related (COMPLETED ✅)

Ad Service Related (COMPLETED ✅)

Camera Service Related (COMPLETED ✅)

Core GUI Service Related (COMPLETED ✅)

Input Service Related (COMPLETED ✅)

Inventory Service Related (COMPLETED ✅)

Quest Service Related (COMPLETED ✅)

Space Content Service Related (COMPLETED ✅)

Marketplace Service Related (COMPLETED ✅)

Networking Service Related (COMPLETED ✅)

User World Data Store Service Related (COMPLETED ✅)

VFX Service Related (COMPLETED ✅)

Interfaces (COMPLETED ✅)

Core Components (COMPLETED ✅)

Scriptable Objects (COMPLETED ✅)

Other Classes (COMPLETED ✅)

Enums (COMPLETED ✅)

Structs (COMPLETED ✅)

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages