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

Turn the index page of the documentation into a redirect to the user guide. #79

Merged
merged 4 commits into from
Oct 10, 2023

Conversation

JustusAdam
Copy link
Collaborator

@JustusAdam JustusAdam commented Oct 10, 2023

What Changed?

Flips the index page of your documentation to a HTML that redirects to the user guide notion page.

Why Does It Need To?

This way we have a) a nicer landing page and also an easy-ish to remember link we can give people to the guide.

Checklist

  • Above description has been filled out so that upon quash merge we have a
    good record of what changed.
  • New functions, methods, types are documented. Old documentation is updated
    if necessary
  • Documentation in Notion has been updated
  • Tests for new behaviors are provided
    • New test suites (if any) ave been added to the CI tests (in
      .github/workflows/rust.yml) either as compiler test or integration test.
      Or justification for their omission from CI has been provided in this PR
      description.
  • Remove the "push" trigger for the workflow after ensuring it works.

@JustusAdam JustusAdam merged commit 64c1f52 into main Oct 10, 2023
5 checks passed
@JustusAdam JustusAdam deleted the doc-redirect branch October 10, 2023 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant