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

docs: Replace static installation examples with generated information #75

Open
jhunkeler opened this issue Feb 7, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jhunkeler
Copy link

jhunkeler commented Feb 7, 2023

In the "Getting Started" documentation:

  1. Use Github API to obtain the latest release object's assets
  2. Generate installation commands for the various configs (e.g. py38, py39, py310, py311 for Linux and MacOS)
  3. Publish

It might be useful to create a template and fill it in for each object (i.e each config gets its own page), and then generate a table on the "Getting Started" landing page. The user would be able to select targeted instructions for a platform/arch/python/release combination and go from there.

@zacharyburnett
Copy link
Collaborator

For now, I've added a version updater in #74. I will look into expanding into separate pages per-release, especially as the filenames and build instructions change.

@zacharyburnett zacharyburnett self-assigned this Feb 23, 2023
@zacharyburnett zacharyburnett added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 20, 2023
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

No branches or pull requests

2 participants