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

Introduce linting for documentation to ensure that it is all valid #5

Closed
Yantrio opened this issue Aug 30, 2023 · 2 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Yantrio
Copy link
Member

Yantrio commented Aug 30, 2023

As we are introducing docusaurus, we need to ensure that all links in the mdx files are valid and resolve correctly.

This may get chunked up into multiple sections of work so we can distribute the effort accordingly.

The initial step of this is to add linting to the main repo

@Yantrio Yantrio self-assigned this Aug 31, 2023
@Yantrio Yantrio changed the title Ensure that all documentation links in opentf repo correctly resolve Introduce linting for documentation to ensure that it is all valid Aug 31, 2023
@Roma36 Roma36 added documentation Improvements or additions to documentation enhancement New feature or request and removed enhancement New feature or request labels Sep 18, 2023
@codiini
Copy link

codiini commented Jun 4, 2024

@Yantrio I think this issue can be closed since the corresponding PR was merged :)

@janosdebugs
Copy link
Contributor

Thanks @codiini !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants