Skip to content

Commit

Permalink
chore(docs): removing homepage and setting up netlify redirects
Browse files Browse the repository at this point in the history
  • Loading branch information
signorecello committed Sep 30, 2024
1 parent eec3a61 commit 88cb59c
Show file tree
Hide file tree
Showing 9 changed files with 2,307 additions and 287 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ jobs:
github-token: ${{ secrets.GITHUB_TOKEN }}
enable-github-deployment: false
deploy-message: "Deploy from GitHub Actions for PR ${{ github.event.number }}"
netlify-config-path: './docs/netlify.toml'
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,6 @@ tooling/noir_js/lib

# docs autogen build
/docs/docs/noir_js/reference/

# Local Netlify folder
.netlify
4 changes: 0 additions & 4 deletions docs/.yarnrc.yml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export default {
docs: {
path: 'processed-docs',
sidebarPath: './sidebars.js',
routeBasePath: '/docs',
routeBasePath: '/',
remarkPlugins: [math],
rehypePlugins: [katex],
versions: {
Expand Down
3 changes: 3 additions & 0 deletions docs/netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[[redirects]]
from = "/docs/*"
to = "/:splat"
10 changes: 5 additions & 5 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
"version": "yarn version::stables && ./scripts/cut_version.sh"
},
"dependencies": {
"@docusaurus/core": "^3.0.1",
"@docusaurus/preset-classic": "^3.0.1",
"@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@easyops-cn/docusaurus-search-local": "^0.35.0",
"@mdx-js/react": "^3.0.0",
"@noir-lang/noir_js": "workspace:*",
Expand All @@ -31,9 +31,9 @@
"remark-math": "^6.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.0.1",
"@docusaurus/tsconfig": "^3.0.1",
"@docusaurus/types": "^3.0.1",
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/tsconfig": "^3.5.2",
"@docusaurus/types": "^3.5.2",
"@types/prettier": "^3",
"docusaurus-plugin-typedoc": "1.0.0-next.18",
"eslint-plugin-prettier": "^5.1.3",
Expand Down
2 changes: 1 addition & 1 deletion docs/src/components/Notes/_blackbox.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:::info

This is a black box function. Read [this section](/docs/noir/standard_library/black_box_fns) to learn more about black box functions in Noir.
This is a black box function. Read [this section](/noir/standard_library/black_box_fns) to learn more about black box functions in Noir.

:::
43 changes: 0 additions & 43 deletions docs/src/pages/index.jsx

This file was deleted.

Loading

0 comments on commit 88cb59c

Please sign in to comment.