Skip to main content

protocols

Don't listen to chatGPT, it will hallucinate.

https://docusaurus.io/docs/markdown-features/links

Markdown file references only work when the source and target files are processed by the same plugin instance. This is a technical limitation of our Markdown processing architecture and will be fixed in the future. If you are linking files between plugins (e.g. linking to a doc page from a blog post), you have to use URL links.

tldr: use full path from site root, e.g. /docs-technical/some-folder/<doc id>

If the article has an id in the front matter, then you must use it: [iteration article](/technical/dsa/lang-comparison/45d75ed5-f226-45d4-b1ff-42135f59d053) using the name of the file will not work: [this article](/technical/dsa/lang-comparison/iteration)

But if you do not have an id in the front matter, then use the file name, do not include the extension:

[article without front matter](/projects/youtube-channels/docusource/tool-front-matter-checker)

example

🧠 How Section Links Work in Docusaurus​

  • Headings (#, ##, etc.) automatically generate anchor slugs
  • The slug is created by:
    • Lowercasing the text
    • Removing most punctuation
    • Replacing spaces with hyphens

So:

### What is an ID?

...becomes:

#what-is-an-id

🧪 Examples​

HeadingAnchor
## Overview#overview
### Step-by-step Guide#step-by-step-guide
### What’s this?#whats-this
### tool-front-matter-checker#tool-front-matter-checker

✅ Tips​

  • Use encodeURIComponent if building links programmatically
  • Use absolute URLs (/technical/...) if crossing plugin boundaries
  • You can test anchors by scrolling to the section and copying from the browser’s address bar

❌ What Won’t Work​

  • Linking with spaces or uppercase: 
    [Wrong](#Step-by-Step Guide)    ❌

Images​

Greenshot gives me the ability to take screenshots and upload to imgur immediately. Use my imgurToS3 tool to backup all these images on imgur... we can optimize and serve ourselves later if there is time/need for it

Tags​

Evernote​

All notes in Evernote are now categorized by note lifecycle:

Evernote Notebooks

See Note Orgnaization Process for more information

The evernote initiative was abandoned due to how easy it is for LLMs to make markdowns. I have plenty of content from current porjects, deep dives, etc.

Docusaurus​

Metadata Items id: <- I use this when I want to link here from other notes, but still

title:<title> Last Update:<Last Update><- I do not track LastUpdate in Evernote, I simply add a hasBeenModifiedSinceLastPublish tag. This is meant to be such primitive "version control" system, because it means I will review the entire document for changes (which helps fight the forgetting curve (spaced repetition)) Tags:<csv of all topic tags in already in evernote>

Front Matter template​

Use frt intellisense popup to insert (vs code snippet). (Or the front matter tool when that is finished)

---
id: ""
title: ""
Last_Update: ""
Tags: [""]
---

Put all topic tags in front matter, then I can write some component/utility to use this information to display anything I may want with https://shields.io/

pk_dclink:oc-c5390b5d

Front Matter ID Tag system​
oc-<8-char id>  Outside content (not in evernote)
na_<something> - This is a deprecated format, these need to be converted to oc 
<Evernote Note ID> e.g. 0971666d-7e7f-20d6-89d9-c2de22357b1a  <- Exmaple Evernote internal id

Use the Generate Short GUID extension after typing oc- to get a guid CTRL + SHIFT + U

Eventually the front matter tool should automatically do this

I am not sure I want to retain all the links to Evernote... for now just drop in the link and we will see how many there are. Dont worry about adding a link if it's a combination of many evernote notes, just use oc

Since the popup component hasn't been written yet, I will need to identify where this will be

Search for pk_popup:
The full format wil be pk_popup:`<Concept for Popup>`
The backticks are added, because the component doesn't exist yet and therefore we cant use it!

Keep in mind this should be mobile friendly