Skip to content

V3 documentation changes#1451

Open
z3dev wants to merge 4 commits intoV3from
docs-part-2
Open

V3 documentation changes#1451
z3dev wants to merge 4 commits intoV3from
docs-part-2

Conversation

@z3dev
Copy link
Copy Markdown
Member

@z3dev z3dev commented Apr 5, 2026

Lots of documentation changes to V3 API, imports, etc.

The new V3 website can be found here. (NOTE: Not official.. Not HTTPS)

http://72.62.112.88/v3/

There are no logic changes. All tests pass.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Does your submission pass tests?

@z3dev z3dev requested review from hrgdavor and platypii April 5, 2026 00:19
@z3dev
Copy link
Copy Markdown
Member Author

z3dev commented Apr 5, 2026

Tons of changes. You don't need to review everything.

But please see the new website, as that has the documentation on-line. You can browse.

Some interesting changes...

  • I moved the boolean functions under 'modeling'.
  • I moved the geometries up. For example, slice is now 'modeling/slice' (previously 'modeling/geometries/slice')

Questions:

  • Should everything be under 'modeling'? Is one huge list confusing?
  • Should the sections, such as 'hulls', 'primitives', etc be maintained? Simplified?

NOTE: This is the documentation hierarchy, not the code or import hierarchy.

FYI. There's a HUGE BUG in jsdoc that prevents the parameters from being shown. A fix is planned.

Copy link
Copy Markdown
Contributor

@hrgdavor hrgdavor left a comment

Choose a reason for hiding this comment

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

organizing into packages makes sense to not have huge list, but is extra burden trying to remember also the prefix .
maybe a meta package: modeling.all that is bunch of aliases saying where the original is. dunno, I am conflicted here.

The PR itself is ok.

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