VCIO-next: Improve and refactor documentation for clarity #1943

Activity

1. tsteenbe

   added this to 04-VulnerableCode nexton Jul 15, 2025
2. tsteenbe

   moved this to Todo in 04-VulnerableCode nexton Jul 15, 2025
3. tsteenbe

   self-assigned this

   on Jul 15, 2025
4. pombredanne

   added this to 03-AboutDoc: better docs to get started and beyondon Jul 15, 2025
5. tsteenbe

   assigned

   DennisClark

   on Jul 15, 2025
6. DennisClark

   unassigned

   tsteenbe

   and

   DennisClark

   on Jul 18, 2025
7. pombredanne

   added this to 00-AboutCodePlanneron Jul 22, 2025
8. pombredanne

   moved this to Todo ready in 00-AboutCodePlanneron Jul 22, 2025
9. pombredanne

   assigned

   tsteenbe

   on Jul 28, 2025
10. tsteenbe

    added

    documentationEverything about documentationEverything about documentation

    on Aug 4, 2025
11. pombredanne

    assigned

    DennisClark

    and unassigned

    tsteenbe

    on Dec 2, 2025
12. DennisClark

    moved this from Todo ready to In progress in 00-AboutCodePlanneron Feb 5, 2026
13. DennisClark commented on Feb 5, 2026

    

    DennisClark

    on Feb 5, 2026

    Member

    More actions

    README.rst improved by PR #2149

    The ReadTheDocs and other elements of the project repo still require review and improving.
14. 6 remaining items

    Load more

15. pombredanne commented on Apr 30, 2026

    

    pombredanne

    on Apr 30, 2026

    Member

    More actions

    @TG1999 Can you review and merge? Thanks
16. pombredanne

    assigned

    TG1999

    on Apr 30, 2026
17. TG1999

    added 6 commits that reference this issue on May 4, 2026

    Update index.rst to restructure

    ...

    0f2b022

    Create PIPELINES-AVID.rst in docs/source

    ...

    e5afca7

    Create SOURCES.rst in docs/source

    ...

    cd2baaf

    Create api_v3_usage.rst in docs/source

    ...

    d18b630

    Update index.rst with new docs

    ...

    486db92

    Merge pull request #2257 from aboutcode-org/1943-refactor-doc

    ...

    b1f4a68
18. TG1999 commented on May 4, 2026

    

    TG1999

    on May 4, 2026

    Last edited by TG1999

    Contributor

    More actions

    This is done now

    Reference:

    • Refactor doc to restructure and improve #1943 #2257
    • Update README.rst to simplify structure #2149

    Docs have been restructured now
19. TG1999

    closed this as completedon May 4, 2026
20. github-project-automation

    moved this from In progress to Done in 00-AboutCodePlanneron May 4, 2026
21. TG1999

    assigned

    pombredanne

    and unassigned

    DennisClark

    and

    TG1999

    on May 8, 2026
22. pombredanne

    moved this from Done to Validated in 00-AboutCodePlanneron May 12, 2026