⚡ [Docs]: Fix and update all documentation #69
Description
Issue Type
Outdated documentation
Documentation Location
The entire Read the Docs site (https://pkynetics.readthedocs.io/)
Current Documentation
The current documentation has not been systematically updated for several major versions (e.g., since before v0.4.0). As a result, it is significantly out of sync with the current codebase.
Key issues include:
- Missing documentation for major new features, most notably the entire
technique_analysis.dscmodule. - Outdated API references for modules that have been refactored.
- Example code that may no longer work or does not reflect best practices with the current API.
- A general lack of guidance on new capabilities, which can lead to user confusion and misinterpretation.
Suggested Changes
The current documentation has not been systematically updated for several major versions (e.g., since before v0.4.0). As a result, it is significantly out of sync with the current codebase.
Key issues include:
- Missing documentation for major new features, most notably the entire
technique_analysis.dscmodule. - Outdated API references for modules that have been refactored.
- Example code that may no longer work or does not reflect best practices with the current API.
- A general lack of guidance on new capabilities, which can lead to user confusion and misinterpretation.
Additional Context
This is a high-priority task. Accurate documentation is essential for user adoption and community engagement, especially after a major feature release. This effort will significantly improve the user experience and reduce the likelihood of support requests related to outdated information.
Guidelines
- I agree to follow this project's Contributing Guidelines
- I have checked that this issue hasn't been reported before