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.

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

feat(docs): Remove landing page #4987

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat(docs): Remove landing page #4987

wants to merge 3 commits into from

Conversation

critesjosh
Copy link
Contributor

@critesjosh critesjosh commented May 6, 2024

Description

Removes the previous landing page for the docs and send them to the first page instead.

Problem*

Resolves #4982

Summary*

I added this plugin for redirecting the landing page to the root of the docs. I am open to other suggestions, but we should preserve the existing url structure so links don't break everywhere.

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 6, 2024
Copy link
Contributor

github-actions bot commented May 6, 2024

Copy link
Contributor

github-actions bot commented May 6, 2024

FYI @noir-lang/developerrelations on Noir doc changes.

Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@algolia/events@4.0.1 None 0 13 kB haroenv
npm/@docsearch/css@3.5.2 None 0 27.9 kB shortcuts
npm/@hapi/hoek@9.3.0 None 0 51.5 kB devinivy
npm/@sideway/formula@3.0.1 None 0 16.9 kB marsup
npm/@sideway/pinpoint@2.0.0 None 0 3.64 kB hueniverse
npm/@types/html-minifier-terser@6.1.0 None 0 9.56 kB types
npm/colord@2.9.3 None 0 114 kB omgovich
npm/combine-promises@1.2.0 environment 0 13.6 kB slorber
npm/consola@2.15.3 environment, filesystem 0 123 kB pi0
npm/emoticon@3.2.0 None 0 13.5 kB wooorm
npm/escape-goat@2.1.1 None 0 6.28 kB sindresorhus
npm/eta@2.2.0 eval, filesystem 0 309 kB nebrelbug
npm/has-yarn@2.1.0 filesystem 0 3.39 kB sindresorhus
npm/import-lazy@2.1.0 None 0 4.77 kB sindresorhus
npm/interpret@1.4.0 None 0 14.9 kB phated
npm/is-npm@5.0.0 None 0 5.1 kB sindresorhus
npm/is-yarn-global@0.3.0 None 0 2.55 kB litomore
npm/mdast-util-to-string@2.0.0 None 0 7.67 kB wooorm
npm/mdn-data@2.0.14 None 0 562 kB escattone
npm/micromark-util-symbol@1.1.0 None 0 38.8 kB wooorm
npm/pretty-time@1.1.0 None 0 10 kB jonschlinkert
npm/react-fast-compare@3.2.2 None 0 16.2 kB formidablelabs
npm/reading-time@1.5.0 None 0 10.2 kB ngryman
npm/require-like@0.1.2 unsafe 0 11.3 kB felixge
npm/sort-css-media-queries@2.1.0 filesystem 0 16.5 kB dutchenkooleg
npm/strip-bom-string@1.0.0 None 0 5.69 kB jonschlinkert
npm/totalist@3.0.1 filesystem 0 7.46 kB lukeed
npm/trim-lines@3.0.1 None 0 7.49 kB wooorm
npm/wildcard@2.0.1 None 0 13.5 kB damonoehlman

🚮 Removed packages: npm/@babel/helper-annotate-as-pure@7.22.5, npm/@babel/helper-builder-binary-assignment-operator-visitor@7.22.15, npm/@babel/helper-function-name@7.23.0, npm/@babel/helper-hoist-variables@7.22.5, npm/@babel/helper-member-expression-to-functions@7.24.5, npm/@babel/helper-module-imports@7.24.3, npm/@babel/helper-module-transforms@7.24.5, npm/@babel/helper-optimise-call-expression@7.22.5, npm/@babel/helper-plugin-utils@7.24.5, npm/@babel/helper-remap-async-to-generator@7.22.20, npm/@babel/helper-replace-supers@7.24.1, npm/@babel/helper-simple-access@7.24.5, npm/@babel/helper-skip-transparent-expression-wrappers@7.22.5, npm/@babel/helper-split-export-declaration@7.24.5, npm/@babel/helper-string-parser@7.24.1, npm/@babel/helper-validator-identifier@7.24.5, npm/@babel/helper-validator-option@7.23.5, npm/@babel/helper-wrap-function@7.24.5, npm/@babel/helpers@7.24.5, npm/@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2, npm/@babel/plugin-syntax-async-generators@7.8.4, npm/@babel/plugin-syntax-class-properties@7.12.13, npm/@babel/plugin-syntax-class-static-block@7.14.5, npm/@babel/plugin-syntax-dynamic-import@7.8.3, npm/@babel/plugin-syntax-export-namespace-from@7.8.3, npm/@babel/plugin-syntax-import-attributes@7.23.3, npm/@babel/plugin-syntax-import-meta@7.10.4, npm/@babel/plugin-syntax-json-strings@7.8.3, npm/@babel/plugin-syntax-logical-assignment-operators@7.10.4, npm/@babel/plugin-syntax-nullish-coalescing-operator@7.8.3, npm/@babel/plugin-syntax-numeric-separator@7.10.4, npm/@babel/plugin-syntax-object-rest-spread@7.8.3, npm/@babel/plugin-syntax-optional-catch-binding@7.8.3, npm/@babel/plugin-syntax-optional-chaining@7.8.3, npm/@babel/plugin-syntax-private-property-in-object@7.14.5, npm/@babel/plugin-syntax-top-level-await@7.14.5, npm/@babel/plugin-syntax-unicode-sets-regex@7.18.6, npm/@babel/plugin-transform-class-properties@7.23.3, npm/@babel/plugin-transform-class-static-block@7.23.4, npm/@babel/plugin-transform-dynamic-import@7.23.4, npm/@babel/plugin-transform-export-namespace-from@7.23.4, npm/@babel/plugin-transform-json-strings@7.23.4, npm/@babel/plugin-transform-logical-assignment-operators@7.23.4, npm/@babel/plugin-transform-nullish-coalescing-operator@7.23.4, npm/@babel/plugin-transform-numeric-separator@7.23.4, npm/@babel/plugin-transform-optional-catch-binding@7.23.4, npm/@babel/plugin-transform-optional-chaining@7.24.5, npm/@babel/plugin-transform-parameters@7.24.5, npm/@babel/plugin-transform-private-methods@7.23.3, npm/@babel/plugin-transform-private-property-in-object@7.23.4, npm/@babel/runtime@7.24.5, npm/@babel/template@7.24.0, npm/@babel/types@7.24.5, npm/@eslint-community/regexpp@4.10.0, npm/@eslint/js@8.57.0, npm/@humanwhocodes/module-importer@1.0.1, npm/@humanwhocodes/object-schema@2.0.3, npm/@jest/schemas@29.6.3, npm/@jest/types@29.6.3, npm/@jridgewell/resolve-uri@3.1.2, npm/@jridgewell/set-array@1.2.1, npm/@jridgewell/trace-mapping@0.3.9, npm/@nodelib/fs.scandir@2.1.5, npm/@nodelib/fs.walk@1.2.8, npm/@szmarczak/http-timer@1.1.2, npm/@tsconfig/node12@1.0.11, npm/@tsconfig/node14@1.0.3, npm/@tsconfig/node16@1.0.4, npm/@types/body-parser@1.19.5, npm/@types/bonjour@3.5.13, npm/@types/connect-history-api-fallback@1.5.4, npm/@types/connect@3.4.38, npm/@types/debug@4.1.12, npm/@types/eslint-scope@3.7.7, npm/@types/eslint@8.56.10, npm/@types/estree@1.0.5, npm/@types/express-serve-static-core@4.19.0, npm/@types/express@4.17.21, npm/@types/hast@2.3.10, npm/@types/http-errors@2.0.4, npm/@types/http-proxy@1.17.14, npm/@types/istanbul-lib-coverage@2.0.6, npm/@types/istanbul-lib-report@3.0.3, npm/@types/istanbul-reports@3.0.4, npm/@types/json-schema@7.0.15, npm/@types/mdast@3.0.15, npm/@types/mdx@2.0.13, npm/@types/mime@1.3.5, npm/@types/ms@0.7.34, npm/@types/parse-json@4.0.2, npm/@types/prop-types@15.7.12, npm/@types/qs@6.9.15, npm/@types/range-parser@1.2.7, npm/@types/react-router-dom@5.3.3, npm/@types/react-router@5.1.20, npm/@types/react@18.3.1, npm/@types/semver@7.5.8, npm/@types/send@0.17.4, npm/@types/serve-index@1.9.4, npm/@types/serve-static@1.15.7, npm/@types/sockjs@0.3.36, npm/@types/ws@8.5.10, npm/@types/yargs-parser@21.0.3, npm/@types/yargs@17.0.32, npm/@webassemblyjs/ast@1.12.1, npm/@webassemblyjs/helper-buffer@1.12.1, npm/@webassemblyjs/helper-numbers@1.11.6, npm/@webassemblyjs/helper-wasm-section@1.12.1, npm/@webassemblyjs/ieee754@1.11.6, npm/@webassemblyjs/leb128@1.11.6, npm/@webassemblyjs/wasm-edit@1.12.1, npm/@webassemblyjs/wasm-gen@1.12.1, npm/@webassemblyjs/wasm-opt@1.12.1, npm/@webassemblyjs/wasm-parser@1.12.1, npm/@webassemblyjs/wast-printer@1.12.1, npm/acorn-jsx@5.3.2, npm/acorn-walk@8.3.2, npm/aggregate-error@3.1.0, npm/ajv-formats@2.1.1, npm/ajv@6.12.6, npm/ansi-align@3.0.1, npm/ansi-colors@4.1.1, npm/ansi-styles@4.3.0, npm/anymatch@3.1.3, npm/arg@4.1.3, npm/assertion-error@1.1.0, npm/babel-plugin-apply-mdx-type-prop@1.6.22, npm/babel-plugin-extract-import-names@1.6.22, npm/bonjour-service@1.2.1, npm/brace-expansion@1.1.11, npm/braces@3.0.2, npm/browser-stdout@1.3.1, npm/browserslist@4.23.0, npm/call-bind@1.0.7, npm/camel-case@4.1.2, npm/chai@4.4.1, npm/char-regex@1.0.2, npm/check-error@1.0.3, npm/ci-info@3.9.0, npm/cli-table3@0.6.4, npm/clone-deep@4.0.1, npm/clone-response@1.0.3, npm/common-path-prefix@3.0.0, npm/core-js-compat@3.37.0, npm/core-js-pure@3.37.0, npm/core-js@3.37.0, npm/create-require@1.1.1, npm/cross-spawn@7.0.3, npm/css-select@4.3.0, npm/csstype@3.1.3, npm/debounce@1.2.1, npm/debug@4.3.4, npm/decamelize@4.0.0, npm/decompress-response@3.3.0, npm/deep-eql@4.1.3, npm/deep-is@0.1.4, npm/default-gateway@6.0.3, npm/define-properties@1.2.1, npm/del@6.1.1, npm/detab@2.0.4, npm/detect-port-alt@1.1.6, npm/detect-port@1.5.1, npm/diff@5.0.0, npm/dir-glob@3.0.1, npm/dns-packet@5.6.1, npm/doctrine@3.0.0, npm/dom-converter@0.2.0, npm/dom-serializer@1.4.1, npm/domhandler@4.3.1, npm/domutils@2.8.0, npm/dot-case@3.0.4, npm/dot-prop@6.0.1, npm/end-of-stream@1.4.4, npm/enhanced-resolve@5.16.0, npm/error-ex@1.3.2, npm/es-module-lexer@1.5.2, npm/escalade@3.1.2, npm/eslint-scope@7.2.2, npm/eslint-visitor-keys@3.4.3, npm/esquery@1.5.0, npm/esrecurse@4.3.0, npm/fast-diff@1.3.0, npm/fast-levenshtein@2.0.6, npm/fastq@1.17.1, npm/faye-websocket@0.11.4, npm/fill-range@7.0.1, npm/finalhandler@1.2.0, npm/flat-cache@3.2.0, npm/flat@5.0.2, npm/flatted@3.3.1, npm/fs-monkey@1.0.6, npm/get-caller-file@2.0.5, npm/get-func-name@2.0.2, npm/get-stream@4.1.0, npm/glob-parent@6.0.2, npm/global-modules@2.0.0, npm/globals@13.24.0, npm/gopd@1.0.1, npm/graphemer@1.4.0, npm/gzip-size@6.0.0, npm/has-property-descriptors@1.0.2, npm/hast-to-hyperscript@9.0.1, npm/hast-util-from-parse5@6.0.1, npm/hast-util-raw@6.0.1, npm/hast-util-to-parse5@6.0.0, npm/hastscript@6.0.0, npm/history@4.10.1, npm/hpack.js@2.1.6, npm/html-entities@2.5.2, npm/html-escaper@2.0.2, npm/htmlparser2@6.1.0, npm/http-errors@2.0.0, npm/http-proxy-middleware@2.0.6, npm/http-proxy@1.18.1, npm/iconv-lite@0.4.24, npm/icss-utils@5.1.0, npm/ignore@5.3.1, npm/inflight@1.0.6, npm/invariant@2.2.4, npm/ipaddr.js@2.2.0, npm/is-alphanumerical@1.0.4, npm/is-binary-path@2.1.0, npm/is-glob@4.0.3, npm/is-plain-object@2.0.4, npm/is-wsl@2.2.0, npm/jest-util@29.7.0, npm/jest-worker@29.7.0, npm/jiti@1.21.0, npm/js-yaml@4.1.0, npm/json-buffer@3.0.1, npm/json-stable-stringify-without-jsonify@1.0.1, npm/keyv@4.5.4, npm/launch-editor@2.6.1, npm/levn@0.4.1, npm/loader-utils@2.0.4, npm/lodash.merge@4.6.2, npm/log-symbols@4.1.0, npm/loose-envify@1.4.0, npm/loupe@2.3.7, npm/lower-case@2.0.2, npm/make-error@1.3.6, npm/mdast-squeeze-paragraphs@4.0.0, npm/mdast-util-definitions@4.0.0, npm/mdast-util-to-hast@10.0.1, npm/memfs@3.6.0, npm/micromatch@4.0.5, npm/multicast-dns@7.2.5, npm/natural-compare@1.4.0, npm/no-case@3.0.4, npm/node-releases@2.0.14, npm/npm-run-path@4.0.1, npm/nth-check@2.1.1, npm/object.assign@4.1.5, npm/on-finished@2.4.1, npm/once@1.4.0, npm/onetime@5.1.2, npm/open@8.4.2, npm/optionator@0.9.4, npm/p-limit@3.1.0, npm/p-map@4.0.0, npm/p-retry@4.6.2, npm/package-json@6.5.0, npm/param-case@3.0.4, npm/parse-entities@2.0.0, npm/parse-json@5.2.0, npm/pascal-case@3.1.2, npm/pathval@1.1.1, npm/pkg-up@3.1.0, npm/postcss-modules-extract-imports@3.1.0, npm/postcss-modules-scope@3.2.0, npm/postcss-selector-parser@6.0.16, npm/postcss@8.4.38, npm/prelude-ls@1.2.1, npm/prettier-linter-helpers@1.0.0, npm/prettier@3.2.5, npm/prompts@2.4.2, npm/property-information@5.6.0, npm/pump@3.0.0, npm/punycode@2.3.1, npm/qs@6.11.0, npm/randombytes@2.1.0, npm/react@17.0.2, npm/readable-stream@3.6.2, npm/readdirp@3.6.0, npm/regenerate-unicode-properties@10.1.1, npm/regenerator-runtime@0.14.1, npm/regenerator-transform@0.15.2, npm/regexpu-core@5.3.2, npm/registry-auth-token@4.2.2, npm/registry-url@5.1.0, npm/regjsparser@0.9.1, npm/remark-parse@8.0.3, npm/remark-squeeze-paragraphs@4.0.0, npm/require-directory@2.1.1, npm/resolve-from@5.0.0, npm/resolve@1.22.8, npm/responselike@1.0.2, npm/run-parallel@1.2.0, npm/rxjs@7.8.1, npm/scheduler@0.20.2, npm/selfsigned@2.4.1, npm/serialize-javascript@6.0.0, npm/serve-index@1.9.1, npm/serve-static@1.15.0, npm/shallow-clone@3.0.1, npm/side-channel@1.0.6, npm/spdy-transport@3.0.0, npm/spdy@4.0.2, npm/std-env@3.7.0, npm/stringify-object@3.3.0, npm/style-to-object@0.3.0, npm/tiny-invariant@1.3.3, npm/to-regex-range@5.0.1, npm/type-check@0.4.0, npm/type-detect@4.0.8, npm/typedarray-to-buffer@3.1.5, npm/unherit@1.1.3, npm/unicode-match-property-ecmascript@2.0.0, npm/unist-util-remove-position@2.0.1, npm/unist-util-remove@2.1.0, npm/unist-util-stringify-position@2.0.3, npm/unist-util-visit-parents@3.1.1, npm/unist-util-visit@2.0.3, npm/universalify@2.0.1, npm/update-browserslist-db@1.0.15, npm/url-parse-lax@3.0.0, npm/v8-compile-cache-lib@3.0.1, npm/vfile-message@2.0.4, npm/wbuf@1.7.3, npm/websocket-driver@0.7.4, npm/which@2.0.2, npm/widest-line@4.0.1, npm/workerpool@6.2.1, npm/write-file-atomic@3.0.3, npm/y18n@5.0.8, npm/yaml@2.4.2, npm/yargs-parser@20.2.4, npm/yn@3.1.1

View full report↗︎

@signorecello
Copy link
Contributor

Hey, looks good, but I think you don't need a redirect? Just setting the baseUrl as / I think would work?

@TomAFrench
Copy link
Member

That would break existing links

@critesjosh
Copy link
Contributor Author

Also, if you check out the deploy, when you first click it it correctly goes to /docs, but if you click the logo in the top left it goes to / and says "page not found". I'm open to suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove index.jsx from docs and redirect landing to /docs
3 participants