Documentation - Modernize for OCCT 8.0.0, GitHub workflow, and vcpkg build system#1256
Merged
Conversation
- Corrected references to data sources and methods in the visualization user guide. - Updated figure paths to ensure proper rendering in documentation. - Improved clarity in code examples for setting colors and handling interactive objects. - Enhanced the XDE documentation with new functionality for loading external CAD files. - Adjusted environment variable instructions for XDE setup. - Fixed minor code issues in the DrawPlugin configuration.
- Corrected thread safety note for STEP format in de_wrapper.md. - Updated resource file paths in draw_test_harness.md to reflect new environment variable usage. - Revised primitive types section in foundation_classes.md to emphasize standard C++ types and clarify deprecated OCCT typedefs. - Adjusted references to classes in modeling_data.md for accuracy. - Updated IGES resource file reference in iges.md to use environment variable. - Modified STEP resource file reference in step.md to align with environment variable usage. - Enhanced clarity in visualization.md regarding sensitive entities and primitive arrays. - Updated XDE environment variable instructions in xde.md for clarity and accuracy.
…rove clarity in upgrade and user guides
…ons and rename 'src' directory to 'resources'
There was a problem hiding this comment.
Pull request overview
Modernizes OCCT documentation for the OCCT 8.0.0 era and GitHub-native workflows, updating build guidance (CMake/vcpkg), refreshing code examples to current APIs/conventions, and removing obsolete infrastructure references (Mantis/Gitolite, legacy tools/docs).
Changes:
- Updates many user guides/specs/tutorials with OCCT 8.0.0 API changes and modernized C++ examples (handles,
IsDone()checks, deprecations). - Migrates contribution/build/documentation guidance to GitHub + CMake target–driven docs, adds vcpkg-centric build path, removes legacy 3rd-party build guide.
- Cleans up samples/docs structure, resource/plugin listings, and various outdated links/figures/code block language tags.
Reviewed changes
Copilot reviewed 39 out of 50 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| resources/DrawResources/DrawPlugin | Removes obsolete Draw plugins (DFBrowser/Inspector) from resource list. |
| dox/user_guides/xde/xde.md | Adds DE_Wrapper note/example; updates env-var guidance and code snippets. |
| dox/user_guides/vis/vis.md | Fixes variable names/namespace qualifiers and updates snippets/figures. |
| dox/user_guides/shape_healing/shape_healing.md | Updates snippets to newer APIs (Result(), FixSameParameter(edge), etc.). |
| dox/user_guides/ocaf/ocaf.md | Modernizes OCAF API references and examples (handles/out-params, method renames). |
| dox/user_guides/modeling_data/modeling_data.md | Updates class/package names and examples for modern OCCT APIs. |
| dox/user_guides/modeling_algos/modeling_algos.md | Modernizes modeling algorithm examples, error handling, and API names. |
| dox/user_guides/mesh/mesh.md | Updates mesh docs (BRep_Tool naming, text, Tcl code block tag). |
| dox/user_guides/foundation_classes/foundation_classes.md | Documents deprecations (Standard_* typedefs, TCol*), modern handle usage, Plugin resource semantics. |
| dox/user_guides/de_wrapper/de_wrapper.md | Updates DE_Wrapper table (thread-safety), examples, and API usage. |
| dox/tutorial/tutorial.md | Updates tutorial narrative and code examples (null-handle guards, IsDone() usage). |
| dox/specification/pbr_math.md | Replaces TODOs and updates external link(s). |
| dox/specification/brep_format.md | Clarifies ASCII vs binary BREP formats; corrects math/parameter descriptions. |
| dox/specification/boolean_operations/boolean_operations.md | Fixes typos/identifiers, updates Tcl tags, and modernizes snippets. |
| dox/samples/samples.md | Restructures samples index (focus on DRAW scripts; references external sample repos). |
| dox/samples/ocaf_func.md | Modernizes OCAF function mechanism sample code. |
| dox/samples/ocaf.md | Updates OCAF tutorial text and code separators; modernizes plugin/toolkit references. |
| dox/samples/novice_guide.md | Reorients newcomer guidance away from removed in-tree app samples toward DRAW scripts. |
| dox/samples/draw_scripts.md | Updates instructions to modern env scripts + source $env(CASROOT)/... workflow. |
| dox/samples/ais_object.md | Fixes figure paths and updates snippets/types for current codebase layout. |
| dox/resources/occt_ug_html.doxyfile | Adjusts Doxygen HTML settings (removes timestamp/transparent formula). |
| dox/introduction/introduction.md | Updates platform/compiler/deps guidance, vcpkg references, and wording. |
| dox/debug/debug.md | Updates debug tooling notes (CMake-era flow, natvis, code block tags). |
| dox/contribution/documentation/documentation.md | Switches doc generation guidance from gendoc to CMake targets; link refresh. |
| dox/contribution/contribution.md | Removes BOM/format cleanup. |
| dox/contribution/coding_rules.md | Updates rules/examples (clang-format note, braces rule, tests section, code block tags). |
| dox/build/build_upgrade.md | Removes legacy 3rd-party build page reference. |
| dox/build/build_occt/building_occt.md | Adds vcpkg quickstart; updates compiler/C++17 requirements and install layout notes. |
| dox/build/build_documentation/building_documentation.md | Updates doc build instructions to CMake targets. |
| dox/build/build_3rdparty/building_3rdparty.md | Removes legacy third-party build guide (content deleted). |
| dox/FILES_HTML.txt | Updates docs file list (removes deleted 3rd-party guide; adds samples index). |
| .github/ISSUE_TEMPLATE/config.yml | Removes Mantis tracker contact link. |
| .github/CONTRIBUTING.md | Updates contribution flow to GitHub PR workflow and fixes links/typos. |
…integration branch
…quence and update method signatures in OCAF and Shape Healing sections
…ing description and update shape array usage for clarity
… contribution workflow, git guide, introduction, samples, and user guides.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
workflow (Pull Requests, Issues, GitHub Actions CI/CD).
weight accessors, evaluation hierarchy refactoring (EvalD0/D1/D2/D3/DN), Handle
out-parameter deprecation, Standard_Mutex → std::mutex, PLib value types, BRepGraph,
TopoDS_TShape redesign, math wrapper deprecation, mesh factory registry, and more.
vcpkg integration, CMake-driven documentation targets replacing legacy gendoc.
pre-7.1.0 upgrade history (archived at dev.opencascade.org/doc), in-tree Inspector
and DFBrowser documentation, 3rd-party build guide (outsourced to vcpkg/upstream).
IsDone() checks, null-handle guards, native C++ types over Standard_ typedefs,
Append() over Appends(), correct variable names.
IDT_ message API replaced with Message_Messenger, thread-safety warning added.