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

Fix Demo links #79

Merged

Conversation

alexanderankin
Copy link
Contributor

This PR adds a requirements.txt file to facilitate developing the mkdocs site.

It also adds placeholder pages for the pages with examples, so that the user does not see broken links. This will hopefully help redirect users back to GitHub to check out the full examples using the mkdocs built-in link. Otherwise it's not so obvious how to get to the example.

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

The requirements.txt is a part of the .devcontainer directory. And thanks for the link placeholders, I will get it integrated https://github.com/gradle/declarative-gradle/blob/main/.devcontainer/requirements.txt

@oleg-nenashev oleg-nenashev added bug Something isn't working documentation Improvements or additions to documentation labels May 28, 2024
@oleg-nenashev oleg-nenashev changed the title fix: add requirements.txt, fix links Fix Demo links May 28, 2024
@oleg-nenashev
Copy link
Member

Thanks a lot! It was on my list for better rendering, but I didn't get to it over the weekend. I will add links checker to the pull request builder

@oleg-nenashev oleg-nenashev merged commit 2797659 into gradle:main May 28, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants