Royal Robotics Documentation

Obsidian Formatting

3 min read

This Note is Unfinished!

This note is missing information, if you have information to help finish this note, share with the Documentation Team and help out!

Obsidian is a note taking tool that designed around linking notes together using backlinks, creating webs of information to sort through.

This is the program that we plan to sort all documentation in.

Note Structure

This Vault going to follow in the style of Johnny Decimal and Evergreen with a few edits

  • Johnny Decimal
    • We have Taken the Number system by Johnny Decimal (Where each Number is a certain category)
    • For Example 20 Folder is Sub Team then 21 is the Engineering Folder
    • However unlike Johnny Decimal, Note aren’t Numbered (No Decimal in the Johnny Decimal System)
    • More info will be found at Folder Structure
  • Evergreen
    • Evergreen has 4 Key Idea we are following
    1. Atomicity
      • Each note should be on an single Idea
    2. Connectivity
      • Each note should connect to other notes
    3. Contextuality
      • Each note should have context to what they relate to (the first paragraph Wikipedia page)
    4. Evolution
      • Notes should be updated rather then create new note
    • However Evergreen isn’t built around the Strict Folder system of Johnny Decimal

Folder Structure

00 - Quick Notes

  • used for temp notes
  • anything that need to be quickly written and sorted later

10 - Mega Link

  • Major Notes that Connect a bunch of smaller notes together
  • Tags and properties are stored here
  • Notes are used to connect things together in the Graph and also act as Starting Points for Topics

20 - Sub Team

  • Permanent Storage for Each Sub Team
  • Every note here should be general to any year of FRC
  • They will also will be updated often because of Evergreen System
  • Each Sub Team has a related Sub Number
    • 21 = Engineering
    • 22 = Programming
    • …

30 - Seasonal

  • Notes Related to this information only relevant to this season
  • Notes are Currently Sorted by Sub Team (could be changed later)
  • Notes are more rough then the 20 - Sub Team

40 - Hardware

  • Permanent Storage for Information on Physical Hardware
  • Information that relate to all sub team should be found here under each part
  • Hardware will be Stored with Sub Number
    • To Be Designed

90 - Template

  • Notes used to help format other notes
  • should be mostly untouched by everyone but Documentation team

Note Structure

Each Note should be in this General Structure

Context

  • This is the start of the document
  • it should help link to any major idea that isn’t in the properties
  • it should also easily explain what this note is about
  • It shouldn’t need a Header

Main Topic

  • The Main Topic of the Note Should be under an H2 Header
  • There can be more then 1 H2 Header but the first one should be the Main Topic and everyone about the Topic is under that Header

Sub Topic

  • Should be H3 Header or Lower
  • is smaller Ideas that can be split off of the Main Topic

References

  • Should be an H2 Header
  • should link to any other notes that relate to the main note

References

Graph View

Backlinks