wiki conventions

---

tags: [docs, conventions, tooling]

Wiki conventions

This GitHub Wiki is used for engineering related internal documentation. The wiki is primarily set up for usage through VSCode, but there are a variety other developer tooling options available.

VSCode setup

1. Clone the wiki into the same parent directory as the Calcite Design System monorepo.

   git clone https://github.com/Esri/calcite-design-system.wiki.git

2. In VSCode, open the File menu and select Open Workspace From File...
3. Select ~/path/to/calcite-design-system.wiki/.vscode/calcite.code-workspace
4. Install the recommended extensions when prompted. If you didn't see a prompt, please ensure Foam is installed.

The workspace contains the Wiki and the Code, which allows you to create and find notes during development.

Finding notes

The Foam extension adds some UI elements to VSCode:

• NOTES: The list of wiki pages
• TAG EXPLORER: The list of tags, which are used to group related notes
• PLACEHOLDERS: The list of links to notes that do not currently exist. This can be helpful for finding broken links or used as a "TODO" reminder.
• ORPHANS: The list of notes that are not linked to by other notes. This can help find notes that aren't integrated into the knowledge graph that will grow over time.
• ALL LINKS: The list of links to (<-) and from (->) the currently open note. This helps find related content.

You can also use the existing VSCode file search to find notes.

Creating notes

There is a template for creating new notes.

1. Open the Command Palette via CMD+SHIFT+P
2. Find/select the Foam: Create New Note From Template command
3. Select the New note template (more may be added eventually)
4. Enter the title in sentence case and press Enter