Skip to content

Overview documentation refactoring and renewal #204

@dpasukhi

Description

@dpasukhi

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

Metadata

Metadata

Labels

1. DocumentationImprovements or additions to documentation2. EnhancementNew feature or request

Type

No type

Projects

Status

On Hold

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions