Changing or Adding Contextual Info

Contextual info can be added in any markdown content. Right now, this is any Task, any Onboarding content, or any Contextual Info, but will be expanded going forward.

In any .md (Markdown) file, wrap the text you want to show the underlined helper-indicator in backticks (`). This is the key to the left of 1 on your keyboard.

The content structure looks like this:

I am a paragraph in a markdown file that contains `contextual information|context-info` about something

The contents of the backticked section is:

`<display text>|<ID of the document for the contextual info>`

The character separating the two section is a pipe (|) which is the shift+\ key on your keyboard.

The ID of must match the filename of a file in the contextual-information folder.

Steps to create a new Contextual Info document:

1. Visit the contextual-information folder.
2. Click "Add file" button (top right) -> "Create new file"
3. Filename should be an all-lowercase unique descriptive ID with hyphens instead of spaces, and have .md ending (for example naics-codes-learn-more.md)
4. Paste template below, and add your content in Markdown syntax
5. To check how it looks, use GitHub's "Preview" tab at the top of the editor.
6. When you're done, add a useful message in the textbox below "Commit new file" and click green Commit button

template:

---
---

Your content here

Steps to create new link to contextual info

1. In GitHub, open the Markdown file you want to add the link to. This will be either in the tasks folder or somewhere in the display-content folder
2. In the file, click the pencil icon (Edit) button near the top-right
3. In the markdown content (NOT the gray matter metadata section), wrap the text you want to be a contextual info link in the backtick format displayed above. Here's your checklist for what to include:

• backtick at the start
• user-facing display text of the link
• pipe symbol
• ID (filename) of the contextual information document (without the .md)
• backtick at the end

To use the example file discussed above, it should be: `Learn more about NAICS codes|naics-codes-learn-more`

4. When you're done, add a useful message in the textbox below "Commit new file" and click green Commit button