You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4
+
5
+
As a side-effect, it can be useful documentation for a human to understand the codebase! Though it's optimized to be read by Claude Code, so it intentionally has human-readability issues.
6
+
7
+
8
+
## Project Overview
9
+
10
+
This is the main personal website of someone who goes by *simshadows* on the internet, hosted on <https://www.simshadows.com/>. Its purpose is quite broad, but sim loves sharing any and all ideas and knowledge with the world. They are an obsessive notetaker and writer, and if they put in the work to create something, they may as well put in a bit of extra work to put it on the internet. The website can be described as a "monorepo of sim's knowledge and online identity" containing blog posts, curated content, cheatsheets, notes, and various personal pages.
11
+
12
+
The website is fully static, built using the Astro framework.
13
+
14
+
15
+
## Software Development Philosophy
16
+
17
+
This is intended to be a life-long personal project. All solutions must be easy to maintain, modify, and inevitably migrate to new frameworks/tools/techniques, or have a good reason for the design. With all proposed solutions and generated code, please include a discussion of these maintainability/flexibility tradeoffs, and if possible, provide alternative ideas and their tradeoffs.
18
+
19
+
We tend prefer minimizing dependencies. If you must import a new package, please justify it.
20
+
21
+
We want as much fail-fast as is reasonable on build-time to ensure the code works like we expect, and data is correct. Compiler warnings are set as aggressive as possible, and the code is littered with code made to throw an error and prevent a successful build if the smallest thing is wrong.
22
+
23
+
## Development Commands
24
+
25
+
### Core Development Workflow
26
+
27
+
-**Install dependencies**: `yarn install`
28
+
-**Start dev server**: `yarn start` (runs on port 8000)
29
+
-**Build for production**: `yarn build` (runs type checking, Astro check, then builds)
30
+
31
+
### Testing and Validation
32
+
33
+
-**Run tests**: `yarn test` (runs Jest test suite)
34
+
-**Type checking**: `yarn typecheck` (runs Astro check and TypeScript compiler)
35
+
36
+
### LaTeX Compilation
37
+
38
+
LaTeX is used only for rendering diagrams into SVGs. LaTeX compilation is done using makefiles that are placed near the LaTeX source files. The SVG artifacts are committed in the repo, so LaTeX compilation is only done on an as-needed basis. SVG artifacts are stored close to where they are used. It's a bit of a mess so you may need to dig around yourself and figure out which `*.svg` files go with what `*.tex` files (hint: look at the makefiles).
39
+
40
+
I'm avoiding adding new LaTeX diagrams since the way I'm doing it is such a pain to use and maintain.
41
+
42
+
43
+
## Directory Structure
44
+
45
+
-`content/`: All content collections (leveraging Astro content collections).
46
+
-`public/`: Files that are copied directly to the web server unmodified.
-`danger*.ts`: All functions that bypass Typescript's type-checking is centralized into this file. In most cases, it's necessary due to limitations with Typescript itself (e.g. type-narrowing unknowns into Arrays), or limitations with the tooling (e.g. Vite's `import.meta.glob` returning unknown types). I hate needing to bypass the type system, and this practice ensures that it is kept to a minimum, and it is easy to find and refactor the dangerous code.
86
+
-`tech-debt.ts`: All significant tech debt is put here to make it easy to find and refactor.
87
+
-`astro.config.mjs`: Astro config.
88
+
-`jest.config.js`: Jest config.
89
+
-`tsconfig.json`: Typescript config.
90
+
91
+
92
+
## Code Architecture Essentials
93
+
94
+
### Content
95
+
96
+
Most of the content is `src/pages/`. The files there are a mix of webpage content/text and code to get things working, so the files can get quite huge if there's a lot of stuff on a page.
97
+
98
+
The other location for content is `content/`.
99
+
100
+
### Content Collections
101
+
102
+
As defined in `src/content.config.ts`, there are two Astro content collections:
103
+
-`blog`: Blog posts loaded from `./content/blog/`
104
+
-`curation`: Curated content loaded from `./content/curation/`
105
+
106
+
`src/pages/` must never use the content collections directly. The respective helper files in `src/helpers/collections/` must be used. These helpers pre-process the collections, reducing duplicate code and helps ensure that `src/pages/` is mostly concerned with the rendering of the content rather than trying to read and validate it.
107
+
108
+
### CSS
109
+
110
+
- Global styles in `src/global.css`
111
+
- Normalize.css is used for CSS reset
112
+
- Component-specific CSS files are co-located with components
- Individual items (breakfast menu on Saturdays from 10am to 2pm. Up-to-date info is on [their instagram](https://www.instagram.com/bosphorusturkishstreetfood/)):
70
+
- <Itc="food"d="2025-10-25"n="Menemen"cost="AUD 20.00, but I got it as part of a breakfast set"/>
71
+
-*"Smashed tomatoes cooked with green pepper and eggs"*
@@ -979,13 +999,22 @@ I sometimes try to put in diacritics/accents or native language characters, but
979
999
-*After you order, I recommend immediately getting your sauce ready, and grab plates for each person at the table if you need them. You'll want to waste as little time as possible when the steaks arrive on the lava plate. You'll need to cut and finish the steak off yourself to the desired doneness.*
980
1000
-*For my first time, I was recommended to go for the Yappari Steak. I was also recommended to try mixing their teriyaki sauce, garlic, and mayo together at the self-serve condiments station.*
981
1001
-*They provide bibs for a reason. The meat juices go everywhere!*
982
-
-**Yo-Chi** (Frozen Yoghurt)
983
-
-*(The yoghurt is make-your-own, so I'll just list the yoghurt flavours I've had.)*
984
-
- 2025-06-15 - Beechworth Honey Frozen Yoghurt
985
-
- 2025-06-15 - Cinnamon Banana Frozen Yoghurt
986
-
- 2024-05-05 - Classic Vanilla Frozen Yoghurt
987
-
- 2024-07-27 - Salted Butterscotch Frozen Yoghurt
988
-
- 2024-05-18 - Signature Tart Frozen Yoghurt
1002
+
- <Ven="Yo-Chi"c="Frozen Yoghurt"/>
1003
+
- The yoghurt is make-your-own, so I'll just list the yoghurt flavours I've had and omit specific toppings:
- <Itd="2024-05-18"n="Signature Tart Frozen Yoghurt"/>
1010
+
- Special items:
1011
+
- <Itd="2025-10-25"n="Bowdy Bowl"/>
1012
+
- This was a promotion only at Barangaroo Yo-Chi on 2025-10-25. They laid out special toppings and gave you a recipe for building your own Bowdy Bowl. I followed the recipe exclusively, including using Coconut frozen yoghurt.
- I was recommended the turkish breakfast, but it probably only runs on Saturdays. Info is on [their instagram](https://www.instagram.com/bosphorusturkishstreetfood/).
0 commit comments