Overhaul the Tech Docs website #198
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add js script for md file transformations Add prettier for formatting via cli
Update config to recognize Footer component and show Starlight credit
Replace dirs in /architecture with only index.md files If a dir contained only index.md file, then rename index.md after the dir name, mv the .md file up a level, and rmdir empty dir Rename architecture/backend/index.md --> backend.md Then mv architecture/backend/*.md ../../ and rmdir Flatten /administration and fix some relative links
Assert an opinion about directory order Order each directory's content via its index.md content
Add missing Architecture files Nest an Upgrading section under Administration Reorder auth files under Customization
Fix credits broken from upgrade in custom footer
…t credits only on home
Add README_FEATURES_1.5.0.md content to upgrading_1_5_0.md and delete the README Add aside syntax Clean up headings, etc.
Deploying archivesspace-tech-docs with
|
| Latest commit: |
ccd665a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://dd67aedc.archivesspace-tech-docs.pages.dev |
brianzelip
force-pushed
the
astro-starlight
branch
from
c85504b to
a553276
Compare
Pass env vars to Cypress via npm scripts Update about dev docs Make import aliases explicit per directory Update Sidebar nav link hover styles
brianzelip
force-pushed
the
astro-starlight
branch
from
a553276 to
f4242cf
Compare
brianzelip
changed the title
brianzelip
changed the title
brianzelip
changed the title
thimios
approved these changes
Dec 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR overhauls the Tech Docs website to use Astro for static site generation instead of Jekyll. The big upgrade here is the change in the website theme, from the Jekyll 'Minimal' theme to Astro 'Starlight'. The Starlight theme provides many UX improvements, including better navigation, search (!!), and design.
About the docs content
The docs content is now found in src/content/docs/.
All of the docs content was left largely intact, save for syntax formatting, internal link adjustments, image path adjustments, and frontmatter changes to accommodate the new framework. New documentation was also added to src/content/docs/about/ to help with authoring Tech Docs content and maintaining the Tech Docs application.
How the new Astro site works
See src/content/docs/about/development.md for further info.
Jekyll site deprecation
The Jekyll site has been deprecated via the
TD-18-deprecated-jekyllbranch which contains the GitHub Actions workflow that published the final iteration of the jekyll codebase as a set of static files with all source code removed.Don't delete the
astro-starlightbranch after merging! We’ll need to make some Cloudflare settings changes and a commit to the codebase after it’s merged before we can delete the branch and start serving the new site from master.