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

Prepare docs for Doctrine website #34

Merged
merged 7 commits into from
Oct 21, 2021

Conversation

driehle
Copy link
Member

@driehle driehle commented Oct 18, 2021

Similar to doctrine/DoctrineModule#733, this PR prepares the docs for being rendered on the Doctrine website. The README has been split into multiple sections and converted from .md to .rst. A .doctrine-project.json is added.

Similar to and in line with:

@driehle driehle marked this pull request as draft October 18, 2021 21:40
@driehle driehle added the Documentation Improvements or additions to documentation label Oct 18, 2021
@driehle driehle added this to the 2.2.1 milestone Oct 18, 2021
docs/en/basic-usage.rst Outdated Show resolved Hide resolved
docs/en/performance-considerations.rst Outdated Show resolved Hide resolved
Copy link
Member

@TomHAnderson TomHAnderson left a comment

Choose a reason for hiding this comment

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

I'm going to approve this for now. But there are a number of grammatical errors throughout the docs which should be corrected. I'm willing to do a PR on the docs as a follow-up to this PR to address them. I'm more concerned about getting this in place on the website.

Please create an issue, assigned to me, to review the docs' English as a follow-up to approving this PR.

@TomHAnderson
Copy link
Member

If you want me to push a PR to this PR before you merge, I'm OK with that. I'll leave the decision for when to merge up to @driehle

@driehle
Copy link
Member Author

driehle commented Oct 21, 2021

@TomHAnderson I'll merge this for now as this will likely enable me to render doctrine-website locally to see if the basic integration is all set up.

@driehle driehle merged commit 6a1d210 into doctrine:2.2.x Oct 21, 2021
@driehle driehle deleted the feature/docs-update branch October 21, 2021 07:24
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

Successfully merging this pull request may close these issues.

None yet

3 participants