| title | Note-taking Conventions - N3RDIUM's Notes | |
|---|---|---|
| description | WIP | |
| template | n3rdium.dev | |
| feeds |
|
|
| lastmod | 2026-03-09 |
[TOC]
Thank you for your interest in this project!
This vault is going to be used with a static site generator in order to cleanly integrate this with my website. Every time this repository is committed to, a webhook will trigger pages deploy on n3rdium.dev.
Avoid renaming, since URLs need stability. For some amount of safety netting, you can implement a redirect system (markdown syntax with a redirect property). This is to be avoided as well wherever possible, since it ruins UX.
The structure plan will keep this in mind, along with longevity. I really need this structure to just work, with minimal refactoring. For decades to come. That’s going to be a fun challenge to tackle.
A little reminder to myself: you’re not writing a textbook here. These are highly optimized, distilled notes. Structure them appropriately. It’ll be completely useless if this ends up turning into a textbook.
All file and folder names will be lowercase with spaces. The use of abbreviations is to be avoided unless they’re universally accepted and dominantly used in literature. This will make way for readable URL slugs and cool stuff like that.
Separate knowledge into levels, like:
- #intro
- #ug
- etc.
Currently “registered” subjects:
- #physics
- #chemistry
- #math
- #cs
Individual notes in these directories will contain the notes for a specific topic in said subject. If multiple notes overlap too much, merge them. No exceptions. Each note will address only ONE topic or concept.
Notes will contain structures and links to all other data types (concepts, derivations, problems, doubts, etc.) in a course-curriculum-like structure. No actual text material, just structure.
Selected, interesting problems. No redundancy. Explore at most one each of a variety of problems instead of compiling those boring “problem sets”. This part of the vault is currently considered to have a relatively low priority.
Keep derivations separate from concepts, linking between them instead. This allows for a much more streamlined structure.
An index of doubts I’ve asked, along with answers and links to the concepts/derivations that helped resolve the doubt. Each file will have a status property which can hold one of three values: {open, resolved, obsolete}. Doubts need not start from the inbox/ directory.
This section of the vault is currently highly experimental. I intend to add practical stuff to complement the theory.
Either individual notes, or non-recursive directories. This area is also highly experimental.
Each file has a subjects property wherever applicable. Subjects is plural (type list) because the text may span across multiple subjects.
Wherever applicable (especially if it’s in the vault already), each note is to have a “prerequisites” section/tags.
When two notes from different subjects containing different concepts clash names, a “disambiguation” page with that name is to be created, which links to separate pages specific to these subjects, concatenated with <subject>_.
Almost all notes in this vault are born in the inbox/ directory. Ideas start here, and get refined.
Use #todo tags to mark sections of an inbox note that need work. An inbox note cannot be adopted into the main structure unless all #todo tags have been resolved.
Each file (or heading or list entry, if applicable) will contain these #<level> tags. This will improve accessibility. Whenever a topic is learnt in more depth than before, the same note is to be appended to with relevant tags in place.
Strictly follow conventional commits. If you’re using the git integration for obsidian, please set the commit message formatting to:
sync: {{date}}