Humanize README and docs for clearer, professional tone
Align with project-template docs/writing-docs.md.
This commit is contained in:
@@ -2,17 +2,14 @@
|
||||
|
||||
Static one-page site for CaseWare / CaseView consulting work. No build step — plain HTML and CSS.
|
||||
|
||||
| File | Purpose |
|
||||
|-------------|----------------------------------|
|
||||
| `index.html`| Page content and structure |
|
||||
| `styles.css`| Layout, typography, theme |
|
||||
**Status:** active. **Live:** https://caseware.levkin.ca · **Booking:** https://cal.levkin.ca/ilia/consult
|
||||
|
||||
**Live site:** https://caseware.levkin.ca
|
||||
**Booking:** https://cal.levkin.ca/ilia/consult
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `index.html` | Page content and structure |
|
||||
| `styles.css` | Layout, typography, theme |
|
||||
|
||||
---
|
||||
|
||||
## Local development
|
||||
## Run it
|
||||
|
||||
```bash
|
||||
cd caseware
|
||||
@@ -22,14 +19,16 @@ python3 -m http.server 8765
|
||||
|
||||
Or open `index.html` directly in a browser (some features work best over HTTP).
|
||||
|
||||
---
|
||||
## Config
|
||||
|
||||
No secrets in repo. Booking link and copy live in `index.html`.
|
||||
|
||||
## Git repository
|
||||
|
||||
| Item | Value |
|
||||
|---------|--------|
|
||||
| Remote | `gitea@10.0.30.169:ilia/caseware.git` |
|
||||
| Branch | `main` |
|
||||
| Item | Value |
|
||||
|------|--------|
|
||||
| Remote | `gitea@10.0.30.169:ilia/caseware.git` |
|
||||
| Branch | `main` |
|
||||
|
||||
### Push changes (from your Mac)
|
||||
|
||||
@@ -40,8 +39,6 @@ git commit -m "Describe your change"
|
||||
git push
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Production deployment
|
||||
|
||||
Traffic flow:
|
||||
@@ -171,7 +168,7 @@ Hard-refresh the browser (Cmd+Shift+R) after deploy.
|
||||
3. Test: `ssh -T gitea@10.0.30.169` — should say “Hi there, ilia!” with no password
|
||||
4. Clone: `git clone gitea@10.0.30.169:ilia/caseware.git /var/www/caseware`
|
||||
|
||||
Do **not** rely on cloning on the Proxmox host unless you prefer that workflow — clone inside 215 with its own key (named e.g. `caseware` in Gitea).
|
||||
Do not rely on cloning on the Proxmox host unless you prefer that workflow — clone inside 215 with its own key (named e.g. `caseware` in Gitea).
|
||||
|
||||
---
|
||||
|
||||
@@ -203,8 +200,8 @@ Verify: `curl -s http://127.0.0.1/ | head -5` should show `<!doctype html>` and
|
||||
|
||||
### 4. Wrong network assumptions
|
||||
|
||||
Lab LAN uses **`10.0.10.0/24`** (gateway `10.0.10.1` on `vmbr0`), not `10.0.30.x`.
|
||||
Gitea lives at **`10.0.30.169`** — different subnet; routing must allow 215 → Gitea.
|
||||
Lab LAN uses `10.0.10.0/24` (gateway `10.0.10.1` on `vmbr0`), not `10.0.30.x`.
|
||||
Gitea lives at `10.0.30.169` — different subnet; routing must allow 215 → Gitea.
|
||||
|
||||
Container IP from DHCP: `pct exec 215 -- hostname -I` → currently **10.0.10.105**.
|
||||
|
||||
@@ -212,7 +209,7 @@ Container IP from DHCP: `pct exec 215 -- hostname -I` → currently **10.0.10.10
|
||||
|
||||
### 5. LinkedIn link 404
|
||||
|
||||
These URLs do **not** work:
|
||||
These URLs do not work:
|
||||
|
||||
- `https://www.linkedin.com/in/idobkin/`
|
||||
- `https://www.linkedin.com/in/iliadobkin/`
|
||||
@@ -253,3 +250,7 @@ Or test from Proxmox host: `curl -I http://10.0.10.105/`
|
||||
- `og:image` for LinkedIn/Slack link previews
|
||||
- Mobile nav for small screens
|
||||
- DHCP reservation for 215 so `10.0.10.105` stays stable (or set static IP in Proxmox)
|
||||
|
||||
## License
|
||||
|
||||
Private repo.
|
||||
|
||||
Reference in New Issue
Block a user