Authoring Documentation

Bridge the gap between your brain and the rest of us. WIP.

Think you’re ready for the big leagues? Prove it by rebasing onto main before continuing work.

Write code, and you may solve a problem. Write documentation, and you'll solve many problems before they even happen.

Use GFM.

Use bold to allow skimming.
Use Lists to express key points instead of using English connectives.
Use Tables to express different things like conditions, and properties.
- This is particularly powerful to avoid having a lot of 'if's to describe complex conditions.

Code Snippet


if (docs.content === 'TECHNICAL'){ 
useCodeBlocks()
console.log('Deleted code'); 
console.log('Added code'); 
}

Icons are from Lucide Icons.