Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: display some or all example in the doc site #70

Closed
harlantwood opened this issue Mar 8, 2024 · 2 comments · Fixed by AstroDraw/astrodraw.github.io#1
Closed
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@harlantwood
Copy link
Contributor

harlantwood commented Mar 8, 2024

Describe the solution you'd like

The examples are great. But I almost passed up this project because the one example shown on https://astrodraw.github.io/ does not show aspects. After finding nothing else that met my needs, I took a second look, and was surprised to see aspects.ts, which was enough for me to download the repo and then see the examples on my localhost.

Possible solutions:

  • Simplest: replace that image or add image(s) from screenshots of more fleshed out examples.
  • More complex: include the actual examples as menu/submenu items in https://astrodraw.github.io/
@harlantwood harlantwood added the enhancement New feature or request label Mar 8, 2024
@afucher
Copy link
Contributor

afucher commented Mar 11, 2024

Nice suggestion!
I think that the main chart should show the features, to avoid people do not look at the library because thinking that it does not have the feature.
I need to improve the documentation, adding more feature examples to the menu.
If you want to contribute, please feel free to open a PR to the doc repo

@afucher afucher added the documentation Improvements or additions to documentation label Mar 11, 2024
@harlantwood
Copy link
Contributor Author

Added a full-featured transits chart in AstroDraw/astrodraw.github.io#1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants