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

Documentation page is empty #942

Open
JacekDziurdzikowski opened this issue Oct 15, 2021 · 3 comments
Open

Documentation page is empty #942

JacekDziurdzikowski opened this issue Oct 15, 2021 · 3 comments

Comments

@JacekDziurdzikowski
Copy link

If you open the page, where documentation should sit - https://www.doctrine-project.org/projects/doctrine-common/en/3.1/index.html#common-documentation - for version 3.1 or any other the page shows no information except the table of contents.

@SenseException
Copy link
Member

This is the current state of the common repository, which becames slimmer and slimmer over time. Some parts were extracted into its own repository. Do you suggest to remove the redundant ToC page?

@JacekDziurdzikowski
Copy link
Author

JacekDziurdzikowski commented Oct 16, 2021

I would suggest renaming section "Common documentation" to "Overview" and give a little bit more information about the purpose and actual concerns of the library.

Nearly empty "Common documentation" section gives false impression of something is being broken.

@SenseException
Copy link
Member

SenseException commented Oct 17, 2021

Sounds like an idea. Do you like to provide a pull request to improve this part of the docs?

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

2 participants