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.

Sign up for GitHub

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

Jump to bottom

Overview documentation refactoring and renewal #204

Open
dpasukhi opened this issue Dec 20, 2024 · 0 comments · May be fixed by #277
Open

Overview documentation refactoring and renewal #204

dpasukhi opened this issue Dec 20, 2024 · 0 comments · May be fixed by #277
Assignees
@dpasukhi @ebelousov
Labels
1. Documentation Improvements or additions to documentation 2. Enhancement New feature or request
Milestone
Release 7.9.1

Comments

@dpasukhi
Copy link
Member

dpasukhi commented Dec 20, 2024 •
edited by ebelousov
Loading

Description

A group issue with refactoring Overview documentation and upgrade.
We can use new AI tools to make documentation more helpful and up to date with code.
Build documentation update
Coding rules
Building description
Specific area details

The current prototypes of documentation:

  • Wiki (Markdown with jo structure)
  • Dox (doxygen without preview)
  • Dox (markdown with folder structure to Web or IDE previews)

The description of ongoing actions:

  • Move Doxygen version to another archived repository.
    • new version will be updated up to 8.0
    • new version will be used to HTML and PDF build
  • Update Wiki to have only reference information to the documentation (OCCT hosted for old, and GitHub preview for 7.9 and higher)
  • Update dox folder to pure markdown (with HTML) for local or web preview. Will be used for any modifications that will be moved to doxygen version.

_
Documentation can be updated by anyone without CLA. (CLA is not required)

Use Case

GitHub Wiki
Dox folder
Deprecated doxygen

Benefits

Synchronization between Wiki and dox folder
More clear documentation
Newcomers welcome guideline.

Additional Context

No response
@dpasukhi dpasukhi added 2. Enhancement New feature or request 0. New The issue was created, but not updated by maintainer. Waiting for updates labels and categories labels Dec 20, 2024
@dpasukhi dpasukhi added 1. Documentation Improvements or additions to documentation and removed 0. New The issue was created, but not updated by maintainer. Waiting for updates labels and categories labels Dec 20, 2024
@dpasukhi dpasukhi added this to the Release 7.9 milestone Jan 23, 2025
@dpasukhi dpasukhi linked a pull request Jan 23, 2025 that will close this issue
Documenting - Rework doxygen documentation for markdawn #277
Open
@dpasukhi dpasukhi moved this from Todo to In Progress in Maintenance Jan 23, 2025
@dpasukhi dpasukhi modified the milestones: Release 7.9, Release 7.9.1 Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dpasukhi dpasukhi

@ebelousov ebelousov

Labels
1. Documentation Improvements or additions to documentation 2. Enhancement New feature or request
Projects
Maintenance
Status: In Progress
Milestone
Release 7.9.1
Development

Successfully merging a pull request may close this issue.

Documenting - Rework doxygen documentation for markdawn dpasukhi/OCCT
2 participants
@dpasukhi @ebelousov