Skip to content

Commit 320ff74

Browse files
committed
Add a live in-browser playground; retire the markdown docs/ folder
The landing page now runs the real, published @sahinur/forgedata package client-side (via esm.sh, no bundler) in a new "Try it live" section: module/generator pickers populated from forge.listGenerators(), plus seed/locale controls, all calling forge.invoke() for genuinely live output. docs/*.md is removed — site/docs.html already covers the same ground in a nicer, browsable format, so keeping both was redundant. Updated every reference (README, CHANGELOG, RELEASE_NOTES, release.yml, site/docs.html) to point at the hosted docs site instead of the deleted files.
1 parent 8d45a99 commit 320ff74

13 files changed

Lines changed: 117 additions & 401 deletions

‎.eslintrc.cjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
browser: true,
1919
es2020: true,
2020
},
21-
ignorePatterns: ["dist", "node_modules", "coverage", "docs/.vitepress/cache"],
21+
ignorePatterns: ["dist", "node_modules", "coverage", "site"],
2222
rules: {
2323
"@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
2424
"@typescript-eslint/no-explicit-any": "off",

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ name: Release
66
# last release, AND the NPM_TOKEN secret below is configured. Until you add
77
# that secret, this workflow safely fails at the publish step and nothing is
88
# published — publishing manually via `npm login && npm publish --access
9-
# public` (see RELEASE_NOTES.md / docs/contributing.md) is unaffected either way.
9+
# public` (see RELEASE_NOTES.md) is unaffected either way.
1010
on:
1111
push:
1212
branches: [main]

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
From this point forward, entries in this file are generated automatically by
99
[semantic-release](https://semantic-release.gitbook.io/) from
1010
[Conventional Commits](https://www.conventionalcommits.org/) on `main` — see
11-
`.releaserc.json` and `docs/contributing.md`. New entries are prepended above
12-
this line by CI; do not hand-edit past releases.
11+
`.releaserc.json` and the docs site's [Contributing](https://devsahinur.github.io/ForgeData/docs.html#contributing)
12+
section. New entries are prepended above this line by CI; do not hand-edit past releases.
1313

1414
## [0.1.0] - Unreleased
1515

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ npx --package=@sahinur/forgedata forgedata generate internet.email --count 5 --s
175175
npx --package=@sahinur/forgedata forgedata generate location.country --locale ja --json
176176
```
177177

178-
Install it globally (`npm install -g @sahinur/forgedata`) to just run `forgedata ...` directly; see [docs/cli.md](./docs/cli.md) for the full flag reference.
178+
Install it globally (`npm install -g @sahinur/forgedata`) to just run `forgedata ...` directly; see the [docs site](https://devsahinur.github.io/ForgeData/docs.html#cli) for the full flag reference.
179179

180180
## Modules
181181

@@ -220,7 +220,7 @@ npm run bench # micro-benchmark, compares against faker if installed
220220
npm run cli -- list # run the CLI from source during development
221221
```
222222

223-
See [docs/](./docs) for the getting-started guide, full API reference, React guide, CLI reference, migration guide from Faker.js, and contributing guide. See [examples/](./examples) for runnable Node, browser, React, and CLI samples.
223+
See the [documentation site](https://devsahinur.github.io/ForgeData/docs.html) (built from `site/docs.html`) for the getting-started guide, full API reference, React guide, CLI reference, migration guide from Faker.js, and contributing guide. See [examples/](./examples) for runnable Node, browser, React, and CLI samples.
224224

225225
## Website
226226

@@ -247,7 +247,7 @@ npm publish --access public
247247

248248
`scripts/publish.sh` wraps that sequence with a confirmation prompt, and `RELEASE_NOTES.md` has a ready-to-paste description for the GitHub Release / npm announcement.
249249

250-
For every release after the first, `.github/workflows/release.yml` runs [semantic-release](https://semantic-release.gitbook.io/) on pushes to `main` — it derives the next version from [Conventional Commits](https://www.conventionalcommits.org/), updates `CHANGELOG.md`, tags, and publishes, but only once you add an `NPM_TOKEN` repository secret. Until then it's a no-op (see `docs/contributing.md#releasing`); it never requires a token to just sit there ready.
250+
For every release after the first, `.github/workflows/release.yml` runs [semantic-release](https://semantic-release.gitbook.io/) on pushes to `main` — it derives the next version from [Conventional Commits](https://www.conventionalcommits.org/), updates `CHANGELOG.md`, tags, and publishes, but only once you add an `NPM_TOKEN` repository secret. Until then it's a no-op (see the docs site's [Contributing](https://devsahinur.github.io/ForgeData/docs.html#contributing) section); it never requires a token to just sit there ready.
251251

252252
## License
253253

‎RELEASE_NOTES.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ forge.person.fullName();
5353
forge.internet.email();
5454
```
5555

56-
See [README.md](./README.md) and [docs/](./docs) for the full guide, API
57-
reference, React guide, CLI reference, and migration notes from Faker.js.
56+
See [README.md](./README.md) and the [documentation site](https://devsahinur.github.io/ForgeData/docs.html)
57+
for the full guide, API reference, React guide, CLI reference, and migration notes from Faker.js.
5858

5959
## Links
6060

6161
- npm: https://www.npmjs.com/package/@sahinur/forgedata
62-
- Docs: [docs/getting-started.md](./docs/getting-started.md)
62+
- Docs: https://devsahinur.github.io/ForgeData/docs.html
6363
- Changelog: [CHANGELOG.md](./CHANGELOG.md)

‎docs/api-reference.md‎

Lines changed: 0 additions & 69 deletions
This file was deleted.

‎docs/cli.md‎

Lines changed: 0 additions & 74 deletions
This file was deleted.

‎docs/contributing.md‎

Lines changed: 0 additions & 72 deletions
This file was deleted.

‎docs/getting-started.md‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎docs/migration-guide.md‎

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)