Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Improve documentation formatting #211

Merged
merged 8 commits into from
Nov 30, 2023
Merged

chore: Improve documentation formatting #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
074953d
chore: Improve documentation formatting
kpears201 Nov 15, 2023
86c4217
chore: Fix docs generated in prs
kpears201 Nov 15, 2023
b0e2ce1
chore: Improve documentation formatting
kpears201 Nov 16, 2023
475ad77
chore: Improve documentation formatting
kpears201 Nov 16, 2023
3bdc72d
Merge branch 'next' into doc-formatting-improvements
kpears201 Nov 16, 2023
e9f228e
chore: Improve documentation formatting
kpears201 Nov 16, 2023
53ece9a
chore: Doc formatting
kpears201 Nov 27, 2023
09e20fc
chore: Doc formatting
kpears201 Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"semi": false,
"singleQuote": true
}
27 changes: 23 additions & 4 deletions package-lock.json
View file
Open in desktop

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

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"devDependencies": {
"@commitlint/cli": "^17.0.3",
"@commitlint/config-conventional": "^17.0.3",
"@firebolt-js/openrpc": "2.1.1",
"@firebolt-js/openrpc": "2.2.0",
"@firebolt-js/schemas": "2.0.0",
"@saithodev/semantic-release-backmerge": "^3.2.0",
"@semantic-release/changelog": "^6.0.1",
Expand Down
6 changes: 4 additions & 2 deletions src/sdks/core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"slice": "npx firebolt-openrpc slice -i ../../../dist/firebolt-open-rpc.json --sdk ./sdk.config.json -o ./dist/firebolt-core-open-rpc.json",
"docs": "npx firebolt-openrpc docs --input ./dist/firebolt-core-open-rpc.json --output build/docs/markdown --as-path",
"wiki": "npx firebolt-openrpc docs --input ./dist/firebolt-core-open-rpc.json --output build/docs/markdown",
"dist:notest": "npm run clean && npm run slice && npm run validate && npm run sdk && npm run docs && npm run dist:copy && echo 'Firebolt Core SDK /dist/ is ready.\n'",
"dist:notest": "npm run clean && npm run slice && npm run validate && npm run sdk && npm run docs && npm run prettier && npm run dist:copy && echo 'Firebolt Core SDK /dist/ is ready.\n'",
"dist:copy": "npm run dist:copy:sdk && npm run dist:copy:docs",
"dist:copy:sdk": "mkdirp ./dist && cp -R build/javascript/src dist/lib && cp ./dist/firebolt-core-open-rpc.json ../../../dist/firebolt-core-open-rpc.json",
"dist:copy:docs": "mkdirp ./dist && cp -R build/docs/markdown dist/docs",
Expand All @@ -25,7 +25,8 @@
"test:setup": "rm -rf test/transpiled-suite && npx tsc --target es6 --moduleResolution node --outDir test/transpiled-suite",
"test": "npm run test:setup && NODE_OPTIONS=--experimental-vm-modules npx --config=jest.config.json --detectOpenHandles jest",
"prepack": "node ../../js/version.mjs validate && npm run broilerplate",
"broilerplate": "rm ./CONTRIBUTING.md && cp ../../../CONTRIBUTING.md ./CONTRIBUTING.md && rm ./LICENSE && cp ../../../LICENSE ./LICENSE && rm ./NOTICE && cp ../../../NOTICE ./NOTICE"
"broilerplate": "rm ./CONTRIBUTING.md && cp ../../../CONTRIBUTING.md ./CONTRIBUTING.md && rm ./LICENSE && cp ../../../LICENSE ./LICENSE && rm ./NOTICE && cp ../../../NOTICE ./NOTICE",
"prettier": "prettier build/**/*.mjs --write --parser babel && prettier build/**/*.md --write --parser markdown"
},
"repository": {
"type": "git",
Expand All @@ -40,6 +41,7 @@
"devDependencies": {
"jest": "^28.1.0",
"jest-environment-jsdom": "^28.1.3",
"prettier": "^3.1.0",
"typescript": "^4.6.4"
},
"keywords": [
Expand Down
6 changes: 4 additions & 2 deletions src/sdks/manage/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"slice": "npx firebolt-openrpc slice -i ../../../dist/firebolt-open-rpc.json --sdk ./sdk.config.json -o ./dist/firebolt-manage-open-rpc.json",
"docs": "npx firebolt-openrpc docs --input ./dist/firebolt-manage-open-rpc.json --output build/docs/markdown --as-path",
"wiki": "npx firebolt-openrpc docs --input ./dist/firebolt-manage-open-rpc.json --output build/docs/markdown",
"dist:notest": "npm run clean && npm run slice && npm run validate && npm run sdk && npm run docs && npm run dist:copy && echo 'Firebolt Manage SDK /dist/ is ready.\n'",
"dist:notest": "npm run clean && npm run slice && npm run validate && npm run sdk && npm run docs && npm run prettier && npm run dist:copy && echo 'Firebolt Manage SDK /dist/ is ready.\n'",
"dist:copy": "npm run dist:copy:sdk && npm run dist:copy:docs",
"dist:copy:sdk": "mkdirp ./dist && cp -R build/javascript/src dist/lib && cp ./dist/firebolt-manage-open-rpc.json ../../../dist/firebolt-manage-open-rpc.json",
"dist:copy:docs": "mkdirp ./dist && cp -R build/docs/markdown dist/docs",
Expand All @@ -25,7 +25,8 @@
"test:setup": "rm -rf test/transpiled-suite && npx tsc --target es6 --moduleResolution node --outDir test/transpiled-suite",
"test": "npm run test:setup && NODE_OPTIONS=--experimental-vm-modules npx --config=jest.config.json --detectOpenHandles jest",
"prepack": "node ../../js/version.mjs validate && npm run broilerplate",
"broilerplate": "rm ./CONTRIBUTING.md && cp ../../../CONTRIBUTING.md ./CONTRIBUTING.md && rm ./LICENSE && cp ../../../LICENSE ./LICENSE && rm ./NOTICE && cp ../../../NOTICE ./NOTICE"
"broilerplate": "rm ./CONTRIBUTING.md && cp ../../../CONTRIBUTING.md ./CONTRIBUTING.md && rm ./LICENSE && cp ../../../LICENSE ./LICENSE && rm ./NOTICE && cp ../../../NOTICE ./NOTICE",
"prettier": "prettier build/**/*.mjs --write --parser babel && prettier build/**/*.md --write --parser markdown"
},
"repository": {
"type": "git",
Expand All @@ -40,6 +41,7 @@
"devDependencies": {
"jest": "^28.1.0",
"jest-environment-jsdom": "^28.1.3",
"prettier": "^3.1.0",
"typescript": "^4.6.4"
},
"keywords": [
Expand Down
Loading