Skip to content

Commit

Permalink
docs: Use mdbook for a docs site. (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
milesj authored Jan 2, 2024
1 parent 9608367 commit bad01d1
Show file tree
Hide file tree
Showing 57 changed files with 2,546 additions and 688 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Docs
on:
push:
branches:
- master
jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: moonrepo/setup-rust@v1
with:
bins: mdbook
- run: mdbook build
- uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book/book/html
allow_empty_commit: true
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## Unreleased

#### 💥 Breaking

- Refactored schema APIs for better usability.
- Updated `TypeScriptOptions.exclude_references` and `external_types` to a `Vec` instead of
`HashSet`.
- Updated `EnumType.variants` to `Vec<LiteralValue>` instead of `Vec<LiteralType>`.
- Updated `ObjectType.required` and `StructType.required` to be wrapped in `Option`.

#### 🚀 Updates

- Added constructor methods for schema types.
- Added `SchemaType::enumerable` method.

## 0.12.12

#### 🚀 Updates
Expand Down
12 changes: 6 additions & 6 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ rust_decimal = "1.33.1"
semver = "1.0.20"
serde = { version = "1.0.193", features = ["derive"] }
serde_json = "1.0.108"
serde_yaml = "0.9.27"
serde_yaml = "0.9.29"
toml = "0.8.8"
url = "2.5.0"
version_spec = "0.1.7"
Expand Down
Loading

0 comments on commit bad01d1

Please sign in to comment.