diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6d785a77244..34a01e84b40 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -10,7 +10,7 @@ on: workflow_dispatch: inputs: disttag: - description: 'Publish "@builder.io/qwik" to NPM using this dist-tag, push the git-tag to the repo and create a Github release. The "latest" and "next" dist-tags will use the version number already committed in package.json.' + description: 'Publish "@builder.io/qwik" to NPM using this dist-tag, push the git-tag to the repo and create a GitHub release. The "latest" and "next" dist-tags will use the version number already committed in package.json.' required: true type: choice default: 'dev' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef6958f8f36..16ebcef6f97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ Next the `start` command will: yarn start ``` -Finally you can use yarn workspace command to run packages' commands, for example: +Finally, you can use yarn workspace command to run packages' commands, for example: ``` yarn workspace qwik-docs dev.ssr @@ -121,10 +121,10 @@ You'll be asked guiding questions which will eventually create a descriptive com 1. Run `yarn release.prepare`, which will test, lint and build. 2. Use the interactive UI to select the next version, which will update the `package.json` `version` property, add the git change, and start a commit message. 3. Create a PR with the `package.json` change to merge to `main`. -4. After the `package.json` with the updated version is in `main`, click the [Run Workflow](https://github.com/BuilderIO/qwik/actions/workflows/ci.yml) button from the "Qwik CI" Github Action workflow. +4. After the `package.json` with the updated version is in `main`, click the [Run Workflow](https://github.com/BuilderIO/qwik/actions/workflows/ci.yml) button from the "Qwik CI" GitHub Action workflow. 5. Select the NPM dist-tag that should be used for this version, then click "Run Workflow". -6. The Github Action will dispatch the workflow to build `@builder.io/qwik` and each of the submodules, build WASM and native bindings, combine them into one package, and validate the package before publishing to NPM. -7. If the build is successful and all tests and validation passes, the workflow will automatically publish to NPM, commit a git tag to the repo, and create a Github release. +6. The GitHub Action will dispatch the workflow to build `@builder.io/qwik` and each of the submodules, build WASM and native bindings, combine them into one package, and validate the package before publishing to NPM. +7. If the build is successful and all tests and validation passes, the workflow will automatically publish to NPM, commit a git tag to the repo, and create a GitHub release. 8. 🚀 ## Pre-submit hooks @@ -135,7 +135,7 @@ The project has pre-submit hooks, which ensure that your code is correctly forma yarn lint ``` -Some of the issues can be fixed automatically by using: +Some issues can be fixed automatically by using: ``` yarn fmt diff --git a/packages/docs/src/components/footer/footer.tsx b/packages/docs/src/components/footer/footer.tsx index da89aaf690e..00e34423161 100644 --- a/packages/docs/src/components/footer/footer.tsx +++ b/packages/docs/src/components/footer/footer.tsx @@ -29,7 +29,7 @@ export const Footer = component$(() => {
  • - +
    • diff --git a/packages/docs/src/components/header/header.tsx b/packages/docs/src/components/header/header.tsx index dfac2764da4..695dc2bae3f 100644 --- a/packages/docs/src/components/header/header.tsx +++ b/packages/docs/src/components/header/header.tsx @@ -85,8 +85,8 @@ export const Header = component$(() => { />
  • - - Github + + GitHub diff --git a/packages/docs/src/components/on-this-page/on-this-page.tsx b/packages/docs/src/components/on-this-page/on-this-page.tsx index 1a512168a02..572c2507319 100644 --- a/packages/docs/src/components/on-this-page/on-this-page.tsx +++ b/packages/docs/src/components/on-this-page/on-this-page.tsx @@ -84,7 +84,7 @@ export const OnThisPage = component$(() => {
  • - Github + GitHub
  • diff --git a/packages/docs/src/components/svgs/github-logo.tsx b/packages/docs/src/components/svgs/github-logo.tsx index de492be54e9..31bdaf0272c 100644 --- a/packages/docs/src/components/svgs/github-logo.tsx +++ b/packages/docs/src/components/svgs/github-logo.tsx @@ -10,7 +10,7 @@ export const GithubLogo = ({ width, height }: GithubLogoProps) => ( height={height} fill="currentColor" role="img" - aria-label="Github Logo" + aria-label="GitHub Logo" > diff --git a/packages/docs/src/routes/docs/faq/index.mdx b/packages/docs/src/routes/docs/faq/index.mdx index bd8aa136792..adbcd4e630b 100644 --- a/packages/docs/src/routes/docs/faq/index.mdx +++ b/packages/docs/src/routes/docs/faq/index.mdx @@ -182,7 +182,7 @@ We think resumability scales without the negative trade-offs of partial hydratio ## Does Qwik have community? -YES, there is a growing community of Qwik developers at [Discord](https://qwik.builder.io/chat) and [Github](https://github.com/BuilderIO/qwik), they are making amazing contributions to the framework, building sites at scale and helping each other. [Join us](https://qwik.builder.io/chat). +YES, there is a growing community of Qwik developers at [Discord](https://qwik.builder.io/chat) and [GitHub](https://github.com/BuilderIO/qwik), they are making amazing contributions to the framework, building sites at scale and helping each other. [Join us](https://qwik.builder.io/chat). ## Is Qwik production ready? diff --git a/packages/qwik-react/README.md b/packages/qwik-react/README.md index d7a51e90e86..f7fdf0a2608 100644 --- a/packages/qwik-react/README.md +++ b/packages/qwik-react/README.md @@ -51,7 +51,7 @@ npm run build.server ## Related - [Qwik Docs](https://qwik.builder.io/docs/overview/) -- [Qwik Github](https://github.com/BuilderIO/qwik) +- [Qwik on GitHub](https://github.com/BuilderIO/qwik) - [@QwikDev](https://twitter.com/QwikDev) - [Discord](https://qwik.builder.io/chat) - [Vite](https://vitejs.dev/) diff --git a/starters/apps/basic/src/routes/index.tsx b/starters/apps/basic/src/routes/index.tsx index 71c06240988..9920539aa42 100644 --- a/starters/apps/basic/src/routes/index.tsx +++ b/starters/apps/basic/src/routes/index.tsx @@ -117,7 +117,7 @@ export default component$(() => {
  • Open issues and contribute on - Github + GitHub
  • diff --git a/starters/apps/documentation-site/src/components/footer/footer.tsx b/starters/apps/documentation-site/src/components/footer/footer.tsx index 8cacdd0307a..ce84ac15445 100644 --- a/starters/apps/documentation-site/src/components/footer/footer.tsx +++ b/starters/apps/documentation-site/src/components/footer/footer.tsx @@ -20,7 +20,7 @@ export default component$(() => { Twitter
  • - Github + GitHub
  • Chat diff --git a/starters/apps/documentation-site/src/components/on-this-page/on-this-page.tsx b/starters/apps/documentation-site/src/components/on-this-page/on-this-page.tsx index a158e9cf881..8c8e13720b6 100644 --- a/starters/apps/documentation-site/src/components/on-this-page/on-this-page.tsx +++ b/starters/apps/documentation-site/src/components/on-this-page/on-this-page.tsx @@ -48,7 +48,7 @@ export default component$(() => {
  • - Github + GitHub
  • diff --git a/starters/apps/documentation-site/src/routes/docs/menu.md b/starters/apps/documentation-site/src/routes/docs/menu.md index 9a9fa3c05b6..935d429fb21 100644 --- a/starters/apps/documentation-site/src/routes/docs/menu.md +++ b/starters/apps/documentation-site/src/routes/docs/menu.md @@ -18,4 +18,4 @@ - [@QwikDev](https://twitter.com/QwikDev) - [Discord](https://qwik.builder.io/chat) -- [Github](https://github.com/BuilderIO/qwik) +- [GitHub](https://github.com/BuilderIO/qwik) diff --git a/starters/apps/documentation-site/src/routes/index.tsx b/starters/apps/documentation-site/src/routes/index.tsx index ffe97a907a4..7692c9d6ac2 100644 --- a/starters/apps/documentation-site/src/routes/index.tsx +++ b/starters/apps/documentation-site/src/routes/index.tsx @@ -124,7 +124,7 @@ export default component$(() => {
  • Open issues and contribute on - Github + GitHub
  • diff --git a/starters/apps/library/README.md b/starters/apps/library/README.md index 251b4ab2f42..4162fab8bf3 100644 --- a/starters/apps/library/README.md +++ b/starters/apps/library/README.md @@ -2,7 +2,7 @@ - [Qwik Docs](https://qwik.builder.io/) - [Discord](https://qwik.builder.io/chat) -- [Qwik Github](https://github.com/BuilderIO/qwik) +- [Qwik on GitHub](https://github.com/BuilderIO/qwik) - [@QwikDev](https://twitter.com/QwikDev) - [Vite](https://vitejs.dev/) - [Partytown](https://partytown.builder.io/)