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

ci: improve links checking #132

Open
mdonadoni opened this issue Jul 5, 2022 · 0 comments
Open

ci: improve links checking #132

mdonadoni opened this issue Jul 5, 2022 · 0 comments

Comments

@mdonadoni
Copy link
Member

Links in the documentation pages are currently checked using awesome_bot

check_docstyle () {
npx -p markdownlint-cli markdownlint docs/*
awesome_bot --allow-dupe --skip-save-results --allow-redirect docs/**/*.md
}

However, not all pages are being checked (from these logs):

Summary
   docs/administration/index.md: ✓
   docs/advanced-usage/index.md: ✓
  docs/getting-started/index.md: ✓
        docs/reference/index.md: ✓
docs/running-notebooks/index.md: ✓
docs/running-workflows/index.md: ✓

We might also consider switching to another tool, given that awesome_bot does not check internal relative links between different documentation pages

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

No branches or pull requests

1 participant