surrealdb / docs.surrealdb.com

The documentation for SurrealDB, powered by Astro
https://surrealdb.com/docs/
75 stars 138 forks source link

Documentation: Leftover Docusaurus files and mentions after the switch to Astro #878

Closed matthewjnield closed 1 month ago

matthewjnield commented 1 month ago

Description

Here are a few places in the SurrealDB documentation repository that still show signs of the previous use of the Docusaurus framework before the switch to the Astro framework.

  1. The 'About' section of the Github repository page still says that the SurrealDB documentation is "powered by Docusaurus"

image

  1. These Docusaurus image files can likely be deleted: src/assets/img/docusaurus.png src/assets/img/undraw_docusaurus_tree.svg src/assets/img/undraw_docusaurus_react.svg src/assets/img/undraw_docusaurus_mountain.svg src/assets/img/docusaurus-social-card.jpg src/assets/img/logo.svg

  2. This JavaScript file includes an if statement that is documented as being designed for use with Docusaurus: aws/viewer-request/index.js

...
27: // Docusaurus base path always has a trailing slash
28: if (path === '/docs') {
29:     return redirect('https://surrealdb.com/docs/');
30: }

Is there an existing issue for this?

Code of Conduct

matthewjnield commented 1 month ago

Here is another thing I noticed:

When I run bun i within the repository per the instructions on the README, it appears that many docusaurus node modules get installed.

image

image

matthewjnield commented 1 month ago

The 'About' section of the Github repository page has been updated, and the node modules are no longer installed. The only items left from this issue are the Docusaurus image files and the if statement in aws/viewer-request/index.js.