Skip to content

Instantly share code, notes, and snippets.

View jeyaramashok's full-sized avatar

Jeyaram Ashokraj jeyaramashok

50 followers · 305 following
View GitHub Profile
@jeyaramashok
jeyaramashok / new-codebase-discovery-template.md
Created March 21, 2025 00:25 — forked from brittanyellich/new-codebase-discovery-template.md
new-codebase-discovery-template

Overview

How to document a new codebase Use this template to document a new codebase.

Business Logic

A place to record any important logic that you come across that is worth documenting.

Landmarks

Refers to the different landmarks of a codebase to help you navigate around. Where are the API methods defined? Where are interactions with the database?