Skip to content

Commit

Permalink
chore: reflect changes in docs hosting, remove vercel.json
Browse files Browse the repository at this point in the history
  • Loading branch information
norskeld committed Apr 15, 2024
1 parent ef6c2ce commit 3c48f15
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 8 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,7 @@ Fork, clone, then instead of `npm install` run:
npm run install:all
```

> **Note**
>
> [!NOTE]\
> This will install dependencies for the package itself, and also for **docs** and **benchmarks** packages. This is due to limitations of the current repository setup and needed to avoid problems with eslint that runs on pre-commit hook.
This project follows [the conventional commits spec][cc-spec] and uses [a slightly modified commitlint preset][commitlint-preset] for automatic linting commits and generating changelog.
Expand All @@ -173,9 +172,9 @@ This project follows [the conventional commits spec][cc-spec] and uses [a slight
[rd]: https://en.wikipedia.org/wiki/Recursive_descent_parser
[parser-combinator]: https://en.wikipedia.org/wiki/Parser_combinator
[cfg]: https://en.wikipedia.org/wiki/Context-free_grammar
[docs]: https://sigma.vm.codes
[docs]: https://sigma.nrsk.dev
[docs-source]: ./docs
[bench]: ./benchmarks
[skypack]: https://skypack.dev
[cc-spec]: https://www.conventionalcommits.org/en/v1.0.0/#summary
[cc-spec]: https://conventionalcommits.org/en/v1.0.0/#summary
[commitlint-preset]: https://github.com/norskeld/config-conventional
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This is the documentation site for [@nrsk/sigma] built with [VitePress].

## Development

The documentation is hosted on Vercel, so changes will be published automatically.
The documentation is hosted on CloudFlare Pages, so changes will be published automatically.

```bash
npm run build # Build for production
Expand Down
3 changes: 0 additions & 3 deletions docs/vercel.json

This file was deleted.

0 comments on commit 3c48f15

Please sign in to comment.