Skip to content

Commit 54349cf

Browse files
committed
docs(readme,docs): replace prose em dashes with standard punctuation
1 parent ac1ea41 commit 54349cf

7 files changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
## Open-source ERP for small-scale artisanal manufacturers and craft businesses
1010

11-
> **Live Demo:** [craftplan.fly.dev](https://craftplan.fly.dev) — log in with `test@test.com` / `Aa123123123123`
11+
> **Live Demo:** [craftplan.fly.dev](https://craftplan.fly.dev). Log in with `test@test.com` / `Aa123123123123`
1212
13-
Craftplan brings all essential business tools into one platformcatalog management, inventory control, order processing, production planning, purchasing, and CRM so you can get off the ground quickly without paying for multiple separate platforms.
13+
Craftplan brings all essential business tools into one platform: catalog management, inventory control, order processing, production planning, purchasing, and CRM, so you can get off the ground quickly without paying for multiple separate platforms.
1414

1515
![Manage overview with schedule, make sheet, and completion snapshot](screenshots/plan.webp)
1616

@@ -100,7 +100,7 @@ See the [setup guide](https://puemos.github.io/craftplan/docs/getting-started/)
100100

101101
## Self-Hosting with Docker
102102

103-
Deploy Craftplan on your own server — no need to clone the repo:
103+
Deploy Craftplan on your own server. No need to clone the repo:
104104

105105
```bash
106106
curl -O https://raw.githubusercontent.com/puemos/craftplan/main/docker-compose.yml
@@ -140,7 +140,7 @@ Commits follow the convention: `type(scope): description` (e.g., `feat(batching)
140140

141141
## License
142142

143-
This project is licensed under the AGPLv3 License — see the [LICENSE](LICENSE) file for details.
143+
This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for details.
144144

145145
## Support
146146

docs/src/pages/docs/api.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ const description = "Interactive API reference for the Craftplan JSON:API";
6464
Craftplan exposes a <a href="https://jsonapi.org"
6565
>JSON:API</a
6666
>-compliant REST API. All endpoints require a Bearer
67-
token generate one in
67+
token; generate one in
6868
<a href={`${base}docs/settings/`}
6969
>Settings &rarr; API Keys</a
7070
>

docs/src/pages/docs/catalog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ Craftplan uses a simple versioning model:
4949
![Pricing Guidance](/craftplan/screenshots/catalog-pricing.webp)
5050

5151
- Materials, labor, and overhead costs are persisted in `catalog_bom_rollups`. The planner, invoices, and insights features read from the rollup, so keeping BOMs current is important.
52-
- Batch completions copy the BOM costs onto each finished order item — these power the **Completion Snapshot** in the planner and future COGS reports.
52+
- Batch completions copy the BOM costs onto each finished order item. These power the **Completion Snapshot** in the planner and future COGS reports.

docs/src/pages/docs/graphql.astro

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ let spectaqlHtml = "";
1414
try {
1515
spectaqlHtml = fs.readFileSync(generatedFile, "utf-8");
1616
} catch {
17-
// Generated files not found will show fallback message
17+
// Generated files not found - will show fallback message
1818
}
1919
---
2020

@@ -74,7 +74,7 @@ try {
7474
Craftplan exposes a <a href="https://graphql.org"
7575
>GraphQL</a
7676
> API at <code>/api/graphql</code>. All requests require
77-
a Bearer token &mdash; generate one in
77+
a Bearer token; generate one in
7878
<a href={`${base}docs/settings/`}
7979
>Settings &rarr; API Keys</a
8080
>

docs/src/pages/docs/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The planner is organized into four tabs:
1717
- **Make Sheet** — Printable run sheet that hides navigation and injects printer-friendly borders. Print via the "Print" button or `Cmd+P` / `Ctrl+P`.
1818
- **Materials** — Rolls up per-material demand, current stock, and shortage warnings for the selected horizon.
1919

20-
The entire surface is LiveView-driven switching tabs or scrolling dates keeps state without extra navigation.
20+
The entire surface is LiveView-driven, so switching tabs or scrolling dates keeps state without extra navigation.
2121

2222
## Marking Work Done & Cost Snapshots
2323

@@ -36,10 +36,10 @@ The snapshot feeds invoices and future insights features.
3636

3737
- The **Make Sheet** dialog shows the entire day's run in a printable table. Capacity-limited products respect their `max_daily_quantity`.
3838
- The **Materials** tab mirrors the "Total required" footer so you can confirm stock before starting a run.
39-
- **Consume All Completed** on the make sheet consumes every completed item with pending stock deductions useful at the end of the day.
39+
- **Consume All Completed** on the make sheet consumes every completed item with pending stock deductions, useful at the end of the day.
4040

4141
## Tips
4242

4343
- The **Return to Overview** button (or the Overview nav item) always routes to `/manage/overview`. Bookmark it for one-click access.
4444
- Planner cards link back to the order detail via the reference badge for quick customer follow-ups.
45-
- To adjust BOMs after seeing the snapshot, use the product link inside the modal — it opens a new tab on Catalog → Products → Recipe.
45+
- To adjust BOMs after seeing the snapshot, use the product link inside the modal, which opens a new tab on Catalog → Products → Recipe.

docs/src/pages/docs/self-hosting.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Deploy Craftplan with Docker on your own server
66

77
## Quick Start
88

9-
Deploy Craftplan without cloning the repo — just download the Compose file and start:
9+
Deploy Craftplan without cloning the repo. Just download the Compose file and start:
1010

1111
```bash
1212
# 1. Download the Compose file and env template
@@ -106,7 +106,7 @@ docker run --rm hexpm/elixir:1.18.3-erlang-27.2.4-debian-bookworm-20250113-slim
106106

107107
### POSTGRES_PASSWORD
108108

109-
Any strong password of your choice — it's used for the bundled PostgreSQL container (not needed if you supply your own `DATABASE_URL`).
109+
Any strong password of your choice. It's used for the bundled PostgreSQL container (not needed if you supply your own `DATABASE_URL`).
110110

111111
---
112112

@@ -140,11 +140,11 @@ The bundled MinIO container works out of the box. Override these to use an exter
140140
| `MINIO_ROOT_PASSWORD` | `minioadmin` | MinIO secret key |
141141
| `AWS_S3_BUCKET` | `craftplan` | S3 bucket name |
142142
| `AWS_S3_SCHEME` | `https://` | S3 endpoint scheme (`http://` for MinIO) |
143-
| `AWS_ACCESS_KEY_ID` | | External S3 access key |
144-
| `AWS_SECRET_ACCESS_KEY` | | External S3 secret key |
143+
| `AWS_ACCESS_KEY_ID` | - | External S3 access key |
144+
| `AWS_SECRET_ACCESS_KEY` | - | External S3 secret key |
145145
| `AWS_S3_HOST` | `s3.amazonaws.com` | S3 endpoint hostname |
146146
| `AWS_REGION` | `us-east-1` | S3 region |
147-
| `AWS_ASSET_HOST` | | Public URL prefix for uploaded assets |
147+
| `AWS_ASSET_HOST` | - | Public URL prefix for uploaded assets |
148148

149149
### Email (Optional)
150150

docs/src/pages/docs/settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Configure which nutritional fact fields are tracked (calories, protein, fat, car
3636

3737
Subscribe to your Craftplan schedule in Google Calendar, Apple Calendar, or any app that supports iCal feeds. Navigate to **Settings → Calendar Feed** to manage subscriptions.
3838

39-
- **Generate Calendar Feed** — Creates a new API key with read-only access to orders, customers, and production batches, and displays a subscription URL. Copy the URL immediately the full key is only shown once.
39+
- **Generate Calendar Feed** — Creates a new API key with read-only access to orders, customers, and production batches, and displays a subscription URL. Copy the URL immediately; the full key is only shown once.
4040
- **Feed list** — All active calendar feeds are listed with their name, masked URL, creation date, and last-used timestamp.
4141
- **Revoke** — Disable a feed at any time. Any calendar app using that URL will stop receiving updates.
4242

@@ -80,7 +80,7 @@ These settings apply to all transactional emails sent by Craftplan (order confir
8080

8181
### Email Provider
8282

83-
Craftplan supports multiple email delivery providers. Select a provider from the **Provider** dropdown in Settings and fill in the required credentials. Once saved, the new provider is active immediately no restart required.
83+
Craftplan supports multiple email delivery providers. Select a provider from the **Provider** dropdown in Settings and fill in the required credentials. Once saved, the new provider is active immediately, no restart required.
8484

8585
| Provider | Required Fields |
8686
|----------|-----------------|

0 commit comments

Comments
 (0)