Skip to content

Enhance documentation and examples for PlotNado#13

Merged
alsmith151 merged 1 commit intomainfrom
docs/clean-and-improve-docs
Mar 10, 2026
Merged

Enhance documentation and examples for PlotNado#13
alsmith151 merged 1 commit intomainfrom
docs/clean-and-improve-docs

Conversation

@alsmith151
Copy link
Copy Markdown
Owner

  • Updated .gitignore to include plotnado-logo.svg.
  • Expanded api_reference.md with new helper methods for GenomicFigure.
  • Added plotnado-logo.svg asset for branding.
  • Created best_practices.md to outline guidelines for figure construction.
  • Introduced example_coverage.md to map track types to runnable examples.
  • Revised faq.md for clarity and consistency in responses.
  • Modified figure_workflows.md to use consistent variable names.
  • Updated index.md to improve introductory content and workflow guidance.
  • Enhanced installation.md with clearer requirements and installation steps.
  • Refined quickstart.md for better clarity and structure in figure creation.
  • Reworked quickstart_tracks.md to emphasize preferred track construction methods.
  • Added new recipes in recipes.md for practical combinations of options.
  • Updated track_aliases.md to clarify alias usage and kwargs routing.
  • Revised track_catalog.md to summarize major track families.
  • Improved troubleshooting.md for better error handling guidance.
  • Updated mkdocs.yaml for improved navigation and branding.
  • Enhanced gen_ref_pages.py to generate more informative aesthetics reference.

- Updated .gitignore to include plotnado-logo.svg.
- Expanded api_reference.md with new helper methods for GenomicFigure.
- Added plotnado-logo.svg asset for branding.
- Created best_practices.md to outline guidelines for figure construction.
- Introduced example_coverage.md to map track types to runnable examples.
- Revised faq.md for clarity and consistency in responses.
- Modified figure_workflows.md to use consistent variable names.
- Updated index.md to improve introductory content and workflow guidance.
- Enhanced installation.md with clearer requirements and installation steps.
- Refined quickstart.md for better clarity and structure in figure creation.
- Reworked quickstart_tracks.md to emphasize preferred track construction methods.
- Added new recipes in recipes.md for practical combinations of options.
- Updated track_aliases.md to clarify alias usage and kwargs routing.
- Revised track_catalog.md to summarize major track families.
- Improved troubleshooting.md for better error handling guidance.
- Updated mkdocs.yaml for improved navigation and branding.
- Enhanced gen_ref_pages.py to generate more informative aesthetics reference.
@alsmith151 alsmith151 merged commit 93d7800 into main Mar 10, 2026
1 check passed
@alsmith151 alsmith151 deleted the docs/clean-and-improve-docs branch March 10, 2026 17:03
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.

1 participant