Skip to main content

Featured

The Docstring Coverage Gate Is the Product: What I Verified in AI Doc Generator

The Docstring Coverage Gate Is the Product: What I Verified in AI Doc Generator Documentation debt never announces itself. It shows up as the three hours you lose reading a function called process_data2 , or as the README that documents an argument the code stopped accepting two refactors ago. Every team knows the number that matters is documentation coverage, and almost nobody has a cheap way to measure it, let alone gate a merge on it. That is the specific pain I went looking for a tool to solve, and it is how I ended up testing AI Doc Generator — a $49 single-file Python CLI that scans a codebase for undocumented functions and classes. This post is what I actually measured in the bundle, on my machine, from a clean copy. Including the parts that don't work. Yes, it is a product I sell, and this article says so plainly rather than dressing up as a neutral review. The real problem: coverage is invisible until it is a crisis Ask a team what fraction of its public functions...

Your Lecture Notes Stop Working in Week Three: The Plain-Markdown Fix

Your Lecture Notes Stop Working in Week Three: The Plain-Markdown Fix

Every semester starts the same way. You open a fresh vault, make a folder per course, and write a good Cornell page for Lecture 01. By Lecture 09 the folder holds nine pages nobody has opened since the day it was written, exam dates live in three different places, and you have no idea what your grade actually is because the marks are scattered across four returned assignments.

None of that is a note-taking problem. It is a wiring problem: the notes were never connected to a review schedule, the schedule was never connected to the exam dates, and the exam dates were never connected to the marks. We built LectureVault as a student vault that wires those four things together in plain Markdown — no app, no account, no plugins.

We sell this kit, so read this as a walkthrough of what is actually in the folder, what it costs, and the cases where you should close the tab and use something else. Everything below is checkable against the file list and the sample data inside the zip.

The three failures a student vault has to survive

Across a semester, the same three things break, and they break in this order.

Notes are captured but never reviewed. A capture template is easy; a review loop is not. If nothing in the vault says this page is due again on Thursday, the page is a one-use document.

Exam dates live in the wrong places. The syllabus has them, the university portal has them, a WhatsApp group has a rumour about them. When they are wrong, every revision plan built on them is wrong.

The running grade is invisible. Students routinely assume they are failing in October because a single low mark feels like the whole course. The arithmetic usually says otherwise, but nobody does the arithmetic by hand.

LectureVault answers all three with structure you can read in a text editor, rather than with another product that owns your semester.

What is in the folder: 18 files, 9 of them templates

Eighteen files in total: seventeen Markdown notes and a LICENSE.txt. There is no code, no script to run, no CSV to import and no configuration step. The nine templates are the working part:

TemplateWhat it does
Templates/Lecture-Note-Cornell.mdThree-zone capture — cues, notes, summary — for discussion-style lectures.
Templates/Lecture-Note-Outline.mdNested-hierarchy capture for dense, structured lectures.
Templates/Course-Reading-Notes.mdSQ3R reading note: survey, question, read, recite, reflect.
Templates/Course-MOC.mdOne page per course: syllabus facts, exams, assignments, lecture index.
Templates/Semester-Planner.mdEvery course with credits and exam dates, plus deadlines this week.
Templates/Exam-Revision-Topic.mdA revision topic with a status, a confidence score and a next-review date.
Templates/Study-Session-Log.mdOne row per session: method, minutes, focus, outcome, next action.
Templates/Grade-Tracker.mdAssessments with weights and scores, and the running-grade arithmetic.
Templates/Flashcard-Inbox.mdA fast capture table for question-and-answer cards, with an ID rule.

The other files are structure and reference: two dashboards (Exam-Countdown.md, Semester-Overview.md), an original study-methods guide covering the Cornell method, active recall, spaced repetition and SQ3R, two fully filled worked examples for a fictional course, plus README.md, START-HERE.md and Home.md.

The front-matter contract is the actual trick

Both lecture templates share one front-matter contract of exactly four keys — course, date, lecturer, topics — and one file-naming rule, for example PSY101-Lecture-03-2026-09-02.md. Because the keys and the names are fixed, a course page can list Cornell notes and outline notes side by side and sort them in lecture order without caring which variant you used. That is the whole reason the vault survives past week three: the pages are interchangeable, so the index keeps working.

The review loop: a 1/3/7/14/30 ladder, visible in the file

Spaced repetition usually means installing software. Here it is a table. Each revision topic carries a status of not started, reviewing or locked, a confidence score from 1 to 5, and a next-review date. The ladder is fixed and printed in the template: the day after class, then +3, +7, +14 and +30 days, and one final pass shortly before the exam.

The handoff is the part that makes it a loop rather than a diagram. Every lecture template ends with four checkboxes headed Questions to review; after class those four questions become lines in a revision-topic note, which is what puts them on the ladder. A question you could not answer stops being a loose end in a page you will never reopen and becomes a scheduled item.

The kit ships one frozen six-pass example so you can see what a topic looks like after the full ladder has run. A topic is only promoted to locked after a confidence of 5 on two consecutive passes — locking is a decision you make from honest recall, not a reward for effort.

The grade arithmetic, written out so you can check it

This is the section most study templates skip. The tracker computes weighted points to two decimals and, crucially, excludes unscored rows from the running grade instead of counting them as zero.

Worked on the sample course, three lines, no hidden formula:

  • Counted weight = the weights of rows that have a score: 25 + 20 + 10 + 10 = 65%.
  • Weighted earned = those rows' weighted points: 21.00 + 18.20 + 9.60 + 8.80 = 57.60.
  • Current grade = 57.60 ÷ 65 × 100 = 88.6%.

The final-exam row reads not yet counted rather than zero, which is why the number above is 88.6 and not 57.6. The projection section then shows what a chosen final score would do to the course grade, as printed arithmetic you can redo on a calculator. It is not a prediction and the kit says so in the file.

Everything above describes the fictional sample course shipped to demonstrate the structure. Your own numbers will be your own, and the structure says nothing about what they will be.

The two dashboards, and why they are hand-maintained

Dashboards/Exam-Countdown.md holds one row per exam with a days-left figure and a count of tracked revision topics. Dashboards/Semester-Overview.md rolls the whole term up: per-course standing, deadlines this week, and revision coverage per course.

Both recalculate when you edit them — there is no plugin doing it for you, and that is deliberate. You recompute days-left every Sunday against today's date and recount topics from your revision notes. It takes a few minutes and it is the only reliable way to notice that a deadline moved.

The sample semester in the dashboards is a fictional student's Fall 2026: five courses, sixteen credits, seven exam dates, twenty-four revision topics across five courses. The countdown figures and the one-days-later check are internally consistent, which matters because a dashboard with a wrong example teaches you nothing.

Obsidian versus Notion, honestly

If you already live in Notion and like it, stay there. The Notion student-template market is crowded and this kit is not competing with it. The case for a local vault is narrower than a pitch would suggest: your notes are plain files on your own disk, there is no account, no subscription, and nothing stops opening because a service changed its plan. That is the entire argument.

One thing worth naming: the kit's tables render in stock Obsidian. There is a single optional Dataview snippet, kept under a clearly marked optional banner, and the rest of the vault does not depend on it. If you never install a plugin, nothing breaks.

The install and the current price

Two routes, both under a minute. Open the folder as a vault and Home.md is your front page, or copy the contents into a vault you already use, keeping the folder names exactly as they are — the capital T on Templates and the capital D on Dashboards matter, because the links in Home.md rely on them. Then open START-HERE.md, which is a timed ten-minute path ending with a planner, a course page, one lecture note, one logged session and one flashcard.

The kit is LectureVault — The Obsidian Student Lecture Notes & Study Vault and it is on Gumroad here: the LectureVault listing.

The live price was $1.00 USD when this post was written, read from the product page's own structured data and its price meta tag. It is an introductory price on a ladder that can move, so check the page rather than trusting this paragraph. The license inside the zip is personal use only, no resale.

Disclosure: this is a product we made and sell. If you buy through the link above, we receive the payment directly. We are the seller, not an affiliate, and we have no reviews or ratings from buyers to quote here.

Who it is NOT for

Skip it if any of these describe you, because there are free options that fit better.

  • You want an app that captures lectures for you. This is structure, not a recorder. There is no audio capture, no transcription and no OCR.
  • You want software to compute your grade. The arithmetic is printed, not automated. A spreadsheet will do it faster if arithmetic is all you need.
  • You need citations and a reference manager. There is no bibliography tooling in this bundle. That belongs to a different kind of vault.
  • You are a Notion user who is happy in Notion. This is a Markdown folder for Obsidian or any editor that opens .md files.
  • You want to resell or redistribute it. The license is personal use only.
  • You expect a grade, GPA, admission or degree outcome. The kit states its own limit plainly: it is study structure, not a guarantee.

Honesty block

Example figures are illustrative planning inputs — not market rates and not earnings.
No legal, tax, insurance, licensing, veterinary, automotive-repair, or financial advice.
No claims of CRM/map/API/invoicing integrations the bundle does not ship.

Corrections and questions are welcome. If we got a fact wrong, write to nandminc2020@gmail.com and we will fix it.

Keep reading

Comments