Reference Library
Overview
The reference library is the vault section for glossary terms, external tools, standards, platforms, and short subject explainers.
It matters because it gives the rest of the documentation system stable subject pages that can be linked from docs, KB entries, SOPs, and library content.
Scope
- External platforms and products
- Glossary and technical concept pages
- Standards, protocols, formats, and tooling references
What Belongs Here
The ref section is for pages that answer the question "what is this?"
That includes concepts, products, standards, formats, protocols, languages, frameworks, and workflow tools that need a stable subject page rather than a task-oriented walkthrough.
What Does Not Belong Here
Reference pages are not the best place for one-off troubleshooting or step-by-step operating instructions.
If the goal is to explain how to perform one concrete task, that usually belongs in the Knowledge Base or in an operational procedure under SOPs.
If the page is about an owned product or internal system, it usually belongs in Docs instead.
How To Read Ref Pages
Most pages in this section start with a definition, then move into practical relevance, comparisons, common use cases, and frequently asked questions.
For products and tools, the Resources section is intended to point to official docs, repos, APIs, SDKs, CLI references, MCP or AI integration pages, and relevant standards where those exist.
Why This Section Matters
Good reference pages create stable graph nodes across the vault.
That makes it easier for docs, KB articles, SOPs, and library snippets to link to shared concepts without re-explaining the same thing each time.
It also helps keep terminology consistent across the wider documentation system.
Typical Ref Topics
Common topics in this section include:
- Web technologies and programming concepts
- Hosting platforms, infrastructure, and operating systems
- Design terminology, file formats, and color spaces
- SaaS products, developer tools, and AI platforms
- Standards, protocols, and implementation vocabulary
Relationship To Other Sections
The reference library supports the other content domains rather than replacing them.
Docs explain owned systems and product areas.
KB entries solve focused problems.
SOPs describe repeatable internal processes.
Lib pages store reusable implementation snippets and patterns.
Frequently Asked Questions
Is every short page supposed to be in ref?
No. The deciding question is whether the page is primarily defining a subject rather than teaching one narrow task.
Can a ref page include workflow context?
Yes, but the page should stay subject-centric rather than turning into a task guide.
Should ref pages link heavily to each other?
Yes. Cross-linking is useful when it connects real concepts, tools, and adjacent subjects.