Skip to content

[Documentation] Core documentation needed #51

Open
Task
#203
Open
[Documentation] Core documentation needed#51
Task
#203
Assignees
LorenzoTettamanti
Labels
documentationImprovements or additions to documentationpermanent issuePermanent issues to avoid duplicatesrustPull requests that update Rust code
Milestone
CortexBrain core v 0.1.0

Description

@LorenzoTettamanti
LorenzoTettamanti
opened on Feb 3, 2025

Task Description:

This task is exclusively for the CortexFlow development team. The objective is to create comprehensive documentation that covers both technical and user-oriented content.

Tasks

Technical Documentation:

Detailed guidelines for developers, including architecture, APIs, and code explanations.
Instructions for setting up the development environment and contributing to the project.

User Documentation:

Simple, user-friendly instructions on how to install, configure, and use CortexFlow.
Frequently Asked Questions (FAQs) and troubleshooting tips.

Additional Information:

Ensure that the documentation is well-structured, clear, and accessible to its target audience. Include examples and diagrams where necessary.

Activity

  1. LorenzoTettamanti
    added
    documentationImprovements or additions to documentation
    on Feb 3, 2025
  2. LorenzoTettamanti
    added this to the CortexBrain core v 0.1.0 milestone on Feb 3, 2025
  3. LorenzoTettamanti
    self-assigned this
    on Feb 3, 2025
  4. LorenzoTettamanti
    added
    rustPull requests that update Rust code
    on Feb 3, 2025
  5. LorenzoTettamanti
    added 2 commits that reference this issue on Feb 22, 2025

    [#51]:

    bdae09c

    [#51]: Created Scripts folder. Moved install and uninstall scripts

    43951cb
  6. LorenzoTettamanti
    added 9 commits that reference this issue on Mar 8, 2025

    [#51]: added contacts page

    4313aaf

    [#51]: updated documentation

    9f571b7

    [#51]: updated readme index

    27786b4

    [#51]: Updated documentation homepage

    14de907

    [#51]: updated documentation index (data plane paragraph refactoring)

    1893e94

    [#51]: updated documentation. removed about section

    8520adc

    [#51] : updated installationm contact and index

    e709743

    [#51] : fixed documentation logo and favicon error

    035220b

    [#51]: added tools sections. updated documentation

    6c5d454

  7. 6 remaining items

  8. LorenzoTettamanti
    added a commit that references this issue on May 26, 2025

    [#51]: added components root documentation

    b500fbf
  9. LorenzoTettamanti
    added this to CortexFlow v0.1on Jun 6, 2025
  10. LorenzoTettamanti
    moved this to In Progress in CortexFlow v0.1on Jun 9, 2025
  11. LorenzoTettamanti
    added a commit that references this issue on Jun 12, 2025

    [#51]: home and installation update

    7d03e36
  12. LorenzoTettamanti
    added
    permanent issuePermanent issues to avoid duplicates
    on Jun 13, 2025
  13. LorenzoTettamanti
    moved this from In Progress to Permanent in CortexFlow v0.1on Jun 13, 2025
  14. LorenzoTettamanti
    added 4 commits that reference this issue on Jul 15, 2025

    [#51]: Removed deprecated core documentation

    0b3e8b9

    [#51] Update documentation styling

    ccb0b14

    [#51]: updated documentation index and installation paragraph

    75f1388

    [#51]: updated documentation styling

    d5456d0
  15. LorenzoTettamanti
    added a commit that references this issue on Dec 21, 2025

    [#51]: Updated documentation index and icons

    a15f951
  16. LorenzoTettamanti
    linked a pull request that will close this issueDocumentation Update #203on Aug 6, 2026
  17. LorenzoTettamanti
    added 3 commits that reference this issue on Aug 7, 2026

    [CortexFlow#51]: Updated getting-started page

    cb4286c

    Documentation Update (#203)

    868c328

    Documentation Update (#203)

    35140d3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpermanent issuePermanent issues to avoid duplicatesrustPull requests that update Rust code

Type

Task

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions