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

Changes to docs fomatting #3130

Open
MrRedstone058 opened this issue Sep 29, 2024 · 2 comments
Open

Changes to docs fomatting #3130

MrRedstone058 opened this issue Sep 29, 2024 · 2 comments

Comments

@MrRedstone058
Copy link
Contributor

MrRedstone058 commented Sep 29, 2024

The Issue:

Currently, there is a disparity between the oncoming experimental Circle documentation and the old Rect/Surface/math documentation as shown below.

Geometry docs
Screenshot_20240929_111648_Chrome
Screenshot_20240929_112034_Chrome

Rect docs
Screenshot_20240929_111713_Chrome

Surface docs
Screenshot_20240929_111809_Chrome

Math docs
Screenshot_20240929_111916_Chrome

As shown above, the current Circle docs have an updated style where attributes and methods subsection as well as using the new mathematic formatting system. However, it is not the same for other older modules and classes.

The Aim:

Discuss the best layout and rewrite the documentation in the new layout (preferably the circle documentation) to achieve consistency and parity.

Feedback is very much wanted.

@itzpr3d4t0r
Copy link
Member

Yes geometry is a bit unconventional, but this isn't a problem limited to geometry alone as you noted. The real issue is we don't have a standard for docs formatting and docs structure/layout, so many issues arise.

@MrRedstone058
Copy link
Contributor Author

perhaps we can agree on something? this issue is open for ideas anyway

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