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

Large docs refactor #11641

Merged
merged 7 commits into from
Oct 7, 2024
Merged

Large docs refactor #11641

merged 7 commits into from
Oct 7, 2024

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Oct 2, 2024

This was done on the plane, and hopefully doesn't conflict too much with my other docs PRs.

The big work here is:

  • Combining the Git integration & Automatic git integration pages. They were never properly separated and it was weird.
  • Making the Continuous Doc Deployment page ready to be shown
  • Decent updates to the Versions page
  • Lots of small updates

📚 Documentation previews 📚

This was done on the plane, and hopefully doesn't conflict too much with my other docs PRs.

The big work here is:

* Combining the Git integration & Automatic git integration pages. They were never properly seperated
* Making the Continuous Doc Deployment page ready to be shown
* Decent updates to the Versions page
* Lots of small updates
@ericholscher ericholscher requested a review from a team as a code owner October 2, 2024 17:34
@ericholscher ericholscher requested a review from agjohnson October 2, 2024 17:34
@ericholscher ericholscher requested a review from plaindocs October 2, 2024 18:33
Copy link
Member Author

Choose a reason for hiding this comment

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

This page is a bit overwhelming, but the existing split was even more confusing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I removed this page because it's basically the same as the docs around adding a project, and it had a bunch of explanation content as well. I think overall we don't need special instructions for importing docs automatically, as that's the default path covered in https://docs.readthedocs.io/en/stable/intro/add-project.html

Copy link
Contributor

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

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

Great stuff!

docs/user/guides/importing-private-repositories.rst Outdated Show resolved Hide resolved
docs/user/guides/pull-requests.rst Outdated Show resolved Hide resolved
@ericholscher
Copy link
Member Author

@agjohnson I'm going to merge this to reduce conflicts and because it's definitely better than what we had. But please do a post-merge review and I can update it.

@ericholscher ericholscher merged commit 630af65 into main Oct 7, 2024
1 of 3 checks passed
@ericholscher ericholscher deleted the doc-refactor branch October 7, 2024 17:21
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.

2 participants