Closed prrao87 closed 5 months ago
@mewim one more question I have is this: What parts of the docs page would need to be connected to the CI pipeline for the website? I noticed that docs/installation.md
is updated from a different location than the source in the main
branch.
For this refactor using Astro, the docs for installation will be located in src/content/docs/installation.md
. Just wanted to make a note of this and any other places that might break CI.
Hi @mewim, I've marked this as ready for review. I tested the docs locally and it works well. I've migrated the old docs to Astro and have added some new sections using the features of Astro. I just want you to do a test locally on your end and verify that the deployment goes through so that we don't have any downtime in the docs page when we merge this to master.
Let me know if you notice any issues!, thanks!
This PR reworks the entire documentation site to use Astro's starlight documentation theme. There are numerous benefits to switching to Astro for our docs:
astro.config.mjs
(no need to manually specify the position of each page in every location).@mewim this is still a draft PR and I'll only mark it as done and send for your review (and deployment) once I add far more content to the docs to make them user-friendly. I wanted us to keep our past documentation contributor list and not lose the entire commit history, which is why I'm doing this in the current repo and not starting a new repo.
In general, I think the theme looks really good and has all the functionality (and more) that will make future additions to the docs far easier.