Skip to content

[BUG] The documentation is not finished #7

Description

@DoDoLu0308

Describe the bug
The documentation in this repository appears to be incomplete. Specifically, under the "Processing Page" section, only a few processing and visualization features are listed (e.g., Interpolation, Despike). However, the actual application includes significantly more features that are not described in the documentation. This creates confusion for users trying to understand or use the full functionality of the tool.

To Reproduce
Steps to identify the issue:

  • Navigate to the repository homepage and open the documentation.

  • Go to the "Processing Page" section.

  • Compare the listed features (e.g., Interpolation, Despike) with the full set of features available in the actual application.

  • Notice that many processing and visualization options are missing from the documentation.

Expected behavior
I expected the documentation to list and describe all the available processing and visualization features, or at least provide a note indicating that the documentation is still under development if that's the case. This would help users understand the tool's capabilities and usage more comprehensively.

Screenshots or error message
N/A (documentation gap rather than a runtime error)

Device

OS: Windows 11

Browser: Chrome

Version: 138.0.7204.169

Additional context
If the documentation is intentionally still in progress, it would be helpful to clarify that in the README or navigation outline. Otherwise, updating the documentation to include all implemented features (e.g., smoothing, baseline correction, etc.) would greatly improve usability for new users.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions