Skip to content

Refactor code structure for readability and maintainability#32

Merged
alsmith151 merged 2 commits into
mainfrom
docs/clean-quarto-based-docs
May 27, 2026
Merged

Refactor code structure for readability and maintainability#32
alsmith151 merged 2 commits into
mainfrom
docs/clean-quarto-based-docs

Conversation

@alsmith151

Copy link
Copy Markdown
Owner

This pull request updates the documentation and example code for PlotNado, focusing on improving onboarding, clarifying workflows, and reorganizing the docs structure. The main changes include a major rewrite of the README.md to streamline installation and usage instructions, updates to the Quarto documentation navigation, and the addition of a new Python module for generating in-memory example data.

Documentation and onboarding improvements:

  • README.md: Completely rewritten for clarity and ease of onboarding. The new README provides concise installation instructions, clearer separation between Python and CLI workflows, and emphasizes reproducible in-memory examples. It also updates feature lists, troubleshooting tips, and contribution guidelines. [1] [2] [3] [4]

Documentation structure and navigation:

  • _quarto.yml: Refactored the navigation structure to improve the order and grouping of documentation sections, update descriptions, and clarify menu items. Some unused or redundant references were removed or renamed for clarity. [1] [2]

Example and utility code:

  • docs/_examples.py: Added a new module containing utility functions for generating synthetic genomic signal, interval, and link data as pandas DataFrames. This module supports reproducible, in-memory examples for documentation and notebooks, and includes example figure-generating functions.

@alsmith151 alsmith151 merged commit cce6fbc into main May 27, 2026
2 checks passed
@alsmith151 alsmith151 deleted the docs/clean-quarto-based-docs branch May 27, 2026 11:08
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.62%. Comparing base (3ec1d9f) to head (1a5982a).
⚠️ Report is 1 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage   80.62%   80.62%           
=======================================
  Files          41       41           
  Lines        5393     5393           
=======================================
  Hits         4348     4348           
  Misses       1045     1045           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants