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

Docs: Adds landing page and redirects #2179

Merged
merged 3 commits into from
Aug 1, 2024
Merged

Conversation

lukegalbraithrussell
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell commented Aug 1, 2024

Summary

This PR stabilizes the redirects behavior. Unsure if it's possible to redirect from anchor links on a Docusaurus/GitHub pages set up (My client-side scripting is getting messed with in prod, even though it works with npm run build/serve, and GH pages doesn't do its own redirecting). Still exploring additional solutions.

But for now:

  • Added a homepage, a simplified version of this repo's Readme. This removes the redirect from / to /getting-started which had a jarring .1 second 404 page viewable in prod.
  • Added redirect from /concepts, /concepts/basic, and /concepts/advanced to /, While none of the three were "pages" on the old site in terms of content, they were working links people could have bookmarked.

I also added a README file for handling the Japanese documentation.

Requirements

Copy link

codecov bot commented Aug 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.07%. Comparing base (f636d75) to head (6f82780).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2179   +/-   ##
=======================================
  Coverage   82.07%   82.07%           
=======================================
  Files          18       18           
  Lines        1545     1545           
  Branches      443      443           
=======================================
  Hits         1268     1268           
  Misses        179      179           
  Partials       98       98           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lukegalbraithrussell lukegalbraithrussell marked this pull request as ready for review August 1, 2024 16:46
@lukegalbraithrussell lukegalbraithrussell added the docs M-T: Documentation work only label Aug 1, 2024
Copy link
Contributor

@technically-tracy technically-tracy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@lukegalbraithrussell lukegalbraithrussell merged commit dccafb2 into main Aug 1, 2024
11 checks passed
@lukegalbraithrussell lukegalbraithrussell deleted the luke-concepts-page branch August 1, 2024 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants