Skip to content

Commit 68037b4

Browse files
committed
update docs
1 parent c5cf6ce commit 68037b4

5 files changed

Lines changed: 25 additions & 14 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@ npm start
1717
## Core Commands
1818

1919
```bash
20-
npm start # NODE_ENV=development, loads .env.development
21-
npm run start:prod # NODE_ENV=production, loads .env.production
22-
npm run build:css # Build ui/dist/styles.css from ui/styles.css
23-
npm run db:migrate # Run migration scripts
24-
npm run db:seed # Run migrations + seed scripts
25-
npm run db:reset # Delete DB, then run migrations + seed scripts
26-
npm run build:docs # Local docs preview
20+
npm start # NODE_ENV=development, loads .env.development
21+
npm run start:prod # NODE_ENV=production, loads .env.production
22+
npm run build:css # Build ui/dist/styles.css from ui/styles.css
23+
npm run db:migrate # Run migration scripts
24+
npm run db:seed # Run migrations + seed scripts
25+
npm run db:reset # Delete DB, then run migrations + seed scripts
26+
npm run build:docs # Local docs build
27+
npx serve .site # Preview local docs after build (include -l flag and port if needed)
2728
```

docs/getting-started.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@ npm install
2222
## Run Commands
2323

2424
```bash
25-
npm start # NODE_ENV=development, loads .env.development
26-
npm run start:prod # NODE_ENV=production, loads .env.production
27-
npm run build:css # build ui/dist/styles.css from ui/styles.css
28-
npm run db:migrate # run migration scripts
29-
npm run db:seed # run migrations + seed scripts
30-
npm run db:reset # delete DB, then run migrations + seed scripts
25+
npm start # NODE_ENV=development, loads .env.development
26+
npm run start:prod # NODE_ENV=production, loads .env.production
27+
npm run build:css # Build ui/dist/styles.css from ui/styles.css
28+
npm run db:migrate # Run migration scripts
29+
npm run db:seed # Run migrations + seed scripts
30+
npm run db:reset # Delete DB, then run migrations + seed scripts
31+
npm run build:docs # Local docs build
32+
npx serve .site # Preview local docs after build (include -l flag and port if needed)
3133
```
3234

3335
## Environment Variables

scripts/build-docs-pages.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ const pageTemplate = ({ pageTitle, navItems, activeSlug, contentHtml }) => {
123123
</nav>
124124
125125
<section class="section-card" aria-live="polite">
126-
<div class="section-body">
126+
<div class="section-body docs-section-body">
127127
<div class="markdown-content">${contentHtml}</div>
128128
</div>
129129
</section>

ui/dist/styles.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,6 +1023,10 @@
10231023
border-color: #2a2a2a;
10241024
padding: calc(var(--spacing) * 3.5);
10251025
}
1026+
.docs-section-body {
1027+
border-top-style: var(--tw-border-style);
1028+
border-top-width: 0px;
1029+
}
10261030
.auth-card {
10271031
margin-inline: auto;
10281032
width: 100%;

ui/styles.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,10 @@
270270
@apply border-t border-line p-3.5;
271271
}
272272

273+
.docs-section-body {
274+
@apply border-t-0;
275+
}
276+
273277
.auth-card {
274278
@apply mx-auto w-full max-w-md;
275279
}

0 commit comments

Comments
 (0)