View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0031896 | Open CASCADE | OCCT:Documentation | public | 2020-11-02 16:13 | 2023-08-01 15:08 |
| Reporter | btokarev | Assigned To | btokarev | ||
| Priority | normal | Severity | integration request | ||
| Status | assigned | Resolution | open | ||
| Product Version | 7.6.0 | ||||
| Target Version | Unscheduled | ||||
| Summary | 0031896: Documentation - Proofreading User manual | ||||
| Description | In the current version of OCCT documentation, several flaws are reported regarding OCCT "Tutorials and Samples" and "User Guides" manual sections. Based on the Teams meeting the following action list is presented: 1) Proofreading (+fact-checking and content-related polishing) for "Tutorials and Samples -> Tutorial"; (done) 2) Consider if document structure fits user requests; check if reorganization of "Tutorials and Samples" or above is required. (partially done in 0032551 and 0031732; may suggest something later on) 3) Enable syntax highlighting for ะก++ code examples through the documentation as presented in "Tutorials and Samples -> Tutorial". (done) 4) Proofreading (+visual output polishing) for "User Guides". 5) Renew external links to https://dev.opencascade.org/ that became obsolete after site update. (partially done by Marketing team and in proofread documents; will keep working on this) | ||||
| Additional information and documentation updates | https://dev.opencascade.org/doc/overview/html/samples.html https://dev.opencascade.org/doc/overview/html/user_guides.html | ||||
| Tags | No tags attached. | ||||
| Test case number | |||||
| parent of | 0032340 | closed | bugmaster | Open CASCADE | OCCT Documentation - highlight C++ code snippets |
| parent of | 0032550 | closed | Open CASCADE | Documentation - Proofreading for "Tutorials and Samples -> Tutorial" | |
| parent of | 0032551 | closed | Open CASCADE | Documentation - Novice user guide for OCCT Documentation | |
| parent of | 0032815 | closed | btokarev | Open CASCADE | Documentation: new links for Products User guides |
| related to | 0031634 | new | Open CASCADE | Documentation - minor clean-up of User Guides from misprints and old classes | |
| related to | 0030664 | new | Open CASCADE | Documentation - Draw Test Harness Manual is outdated | |
| related to | 0028270 | new | Open CASCADE | Documentation, Draw Harness - Translate all French text in commands help to English | |
| child of | 0027191 | closed | Community | Documentation - redesign of information architecture |
|
|
Branch CR0031896 has been updated by inv. SHA-1: ad3ef92d6eb85a7581831f07af979e6f29cb356f Detailed log of new commits: Author: bugmaster Date: Thu Apr 29 10:20:53 2021 +0300 Test push |
|
|
Branch CR0031896 has been updated forcibly by inv. SHA-1: 361cc345b077e94c7f1a08ae0778f3ec8bfba6fc |
|
|
Branch CR0031896 has been updated by btokarev. SHA-1: 05a503bf5f8f2df15c50df53b24183f54f791605 Detailed log of new commits: Author: btokarev Date: Thu Apr 29 10:39:35 2021 +0300 0031896: Documentation - Proofreading User manual Required HDD space updated - Small fix to verify workflow |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2020-11-02 16:13 | btokarev | New Issue | |
| 2020-11-02 16:13 | btokarev | Assigned To | => btokarev |
| 2020-11-06 14:33 | kgv | Summary | OCCT User manual: Proofreading => Documentation - Proofreading User manual |
| 2020-11-06 14:34 | kgv | Relationship added | child of 0027191 |
| 2021-04-29 10:20 | git | Note Added: 0100648 | |
| 2021-04-29 10:21 | git | Note Added: 0100649 | |
| 2021-04-29 10:39 | git | Note Added: 0100650 | |
| 2021-04-29 13:02 | btokarev | Relationship added | parent of 0032340 |
| 2021-07-08 11:20 | btokarev | Description Updated | |
| 2021-09-01 14:40 | btokarev | Relationship added | related to 0031634 |
| 2021-09-01 14:41 | btokarev | Relationship added | related to 0030664 |
| 2021-09-01 14:50 | btokarev | Relationship added | parent of 0032550 |
| 2021-09-01 15:00 | btokarev | Relationship added | parent of 0032551 |
| 2021-10-06 17:24 |
|
Status | new => assigned |
| 2021-10-21 18:47 |
|
Target Version | 7.6.0 => 7.7.0 |
| 2021-10-23 01:15 | btokarev | Relationship added | related to 0028270 |
| 2021-11-02 19:45 | btokarev | Description Updated | |
| 2021-11-02 19:46 | btokarev | Description Updated | |
| 2022-02-04 17:40 | btokarev | Relationship added | parent of 0032815 |
| 2022-10-24 10:39 |
|
Target Version | 7.7.0 => 7.8.0 |
| 2023-08-01 15:08 | dpasukhi | Target Version | 7.8.0 => Unscheduled |
