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: Rebase against newer starter pack #5071

Open
medubelko opened this issue Sep 26, 2024 · 1 comment
Open

Docs: Rebase against newer starter pack #5071

medubelko opened this issue Sep 26, 2024 · 1 comment
Labels
documentation Documentation changes to the project itself or in-code help triaged

Comments

@medubelko
Copy link
Contributor

medubelko commented Sep 26, 2024

What needs to get done

  • Once the starter pack improvements are complete, rebase the docs against it.
  • Correct any warnings or errors in the docs resulting from the new tests.

Why it needs to get done

We're using an old version of the RTD starter pack. The latest version is more modular, relying on extensions over bespoke configuration code, and will remove issues related to dependency management. It also provides testing with Vale, so we’re missing out on checks for basic style adherence. The documentation team is also developing additional tests and analytics that will land at the end of this cycle.

We should rebase so the docs benefit from these developments.

@medubelko medubelko added documentation Documentation changes to the project itself or in-code help triaged labels Sep 26, 2024
Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3489.

This message was autogenerated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes to the project itself or in-code help triaged
Projects
None yet
Development

No branches or pull requests

1 participant