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.

Sign up for GitHub

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

Jump to bottom

README supports dynamic documentation #8

Closed
2 of 3 tasks
alvyn279 opened this issue Dec 17, 2020 · 1 comment · Fixed by #9 or #12
Closed
2 of 3 tasks

README supports dynamic documentation #8

alvyn279 opened this issue Dec 17, 2020 · 1 comment · Fixed by #9 or #12
Assignees
@alvyn279
Labels
docs Improvements or additions to documentation v1 first version release

Comments

@alvyn279
Copy link
Owner

alvyn279 commented Dec 17, 2020 •
edited
Loading

Context

jsii has a really cool feature where the example Typescript code in README is transformed into the target language at package/publish time. This mean NPM and PyPi will respectively show working TS and Python code examples.

We need to play around that to ensure coherent installation steps and code samples are shown in the packages homepages.

Tasks

  • Remove Typescript header
  • Have both npm and pip install
  • GitHub README will still show default README, so we need to include a statement for specific python example

Alternatives

Have both TS and Python install/code samples. Will clutter README.

Notes

N/A
@alvyn279 alvyn279 added docs Improvements or additions to documentation v1 first version release labels Dec 17, 2020
@alvyn279 alvyn279 self-assigned this Dec 17, 2020
alvyn279 added a commit that referenced this issue Dec 18, 2020
@alvyn279
chore(v1): [#8] support jsii dynamic documentation
11789d1
@alvyn279 alvyn279 mentioned this issue Dec 18, 2020
Merged
@alvyn279
Copy link
Owner Author

re-opening because I missed the last step.

@alvyn279 alvyn279 reopened this Dec 18, 2020
alvyn279 added a commit that referenced this issue Dec 19, 2020
@alvyn279
chore(v1): [#8] explicitly linked python and ts docs
d98dd9b
@alvyn279 alvyn279 mentioned this issue Dec 19, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alvyn279 alvyn279

Labels
docs Improvements or additions to documentation v1 first version release
Projects
None yet
Milestone
No milestone
1 participant
@alvyn279