Add a wiki to organize learning material - #9
Draft
fafouine wants to merge 1 commit into
Draft
Conversation
Introduce a wiki/ knowledge base (Home, Getting Started, Glossary) that ties together the logs, concepts, and tag index, and link to it from the README so it's the front door to the repository. Co-authored-by: Johanie Martin Lafond <omgwtfgtfoomw@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a wiki to the repository so the learning material has a clear front door. The
learning-logitself already exists — this fills in the missing "wiki for the learning material I acquire" by tying the logs, concepts, and tag index together into a navigable knowledge base.What changed
wiki/Home.md— landing page mapping each section (LOGS/,concepts/,tags/, Glossary) to where it lives, with "Start here" links.wiki/Getting-Started.md— the log → concept → tag workflow, the three tag formats (#tag,#.method(),#func()), and how to regenerate the index.wiki/Glossary.md— an alphabetical glossary seeded with clearly-labeled example entries to establish the format (thefeature/wiki-glossarybranch name signalled a glossary was intended).README.md— a prominent 📚 Wiki section near the top so the wiki is discoverable.Verification
tags/folder rather than the not-yet-generatedtags/index.md, so nothing is dead on day one.python scripts/generate_tag_index.py— unchanged behavior (the indexer scans onlyLOGS/andconcepts/).Explainer doc
Full background, intuition, walkthrough, alternatives, and a quiz: Explainer: Add a wiki to the learning-log repo
🤖 Opened as a draft for review. Documentation-only; no runtime code changed.