search

PantherLAB / PantherDashboard

Panther Dashboard for DQMH is a tool designed to improve the Developer Experience when working with DQMH Framework.
https://pantherlab.github.io/PantherDashboard/
12 stars 4 forks source link

Full Antidoc integration #17

Closed enoearias closed 9 months ago

enoearias commented 2 years ago

I'm planning to integrate Panther Dashboard with Antidoc project.

I found Antidoc is really an awesome tool to understand projects, the current version of Panther Dashboard can open Antidoc Output, Panther Dashboard helps documennting your project and Antidoc creates oustanding documents based on the information captured on the project/code.

Right now these are the integration ideas

  1. Add some option/menu called "Rate your documentation", this option will scan all your project looking for documentation, the search includes .lvproj .lvlib and vi files, if vis will search the documentation is different than the default one
  2. This option will show result Green when all the documentation is filled and you are ready to call antidoc
  3. this opction will show yellow if there are some missing elements, maybe show a percentage or just green reed per element, to be defined.
  4. will show red if there is no documentation.
  5. add an option/ menu or something to fill all the fields required by antidoc, panther dashboard will save a local ini file on the same .lvproj path with this information
  6. If this file exist when calling the formulary it will be prefilled, you can allways change all the information
  7. Add an option/menu "generate Antidoc Output", this will use the local information to use Antidoc CLI and generate documentation.
enoearias commented 2 years ago

Discussion about this feature request happened on the 2022 Q3 Trusted Advisors Meeting , Olivier and Enrique need to coordinate to not overlap on this feature.

enoearias commented 1 year ago

Partial progress on version 3.0.0.1