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: Add some messages flagging the upcoming requirement of a .readthedocs.yaml #10389

Merged
merged 8 commits into from
Jun 8, 2023

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Jun 5, 2023

These are just helpful pointers, documentation should be improved afterwards

Fixes #10372


📚 Documentation previews 📚

@benjaoming benjaoming requested a review from ericholscher June 5, 2023 21:39
@benjaoming benjaoming requested a review from a team as a code owner June 5, 2023 21:39
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

These changes look good other than the tutorial, I think we want to prioritize an update there, not a warning that is a "dead end" for the user.

Customizing the build process
-----------------------------
Adding a configuration file
---------------------------
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this section rename works well for the tutorial. It speaks more directly to the actionable item.

image

@benjaoming benjaoming requested a review from ericholscher June 7, 2023 12:19
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Looks good with a small edit.

@benjaoming benjaoming merged commit a9dc303 into main Jun 8, 2023
@benjaoming benjaoming deleted the docs/deprecate-no-config-file branch June 8, 2023 10:19
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.

Docs: Config file deprecation warnings
3 participants