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

Lots of links broken in API live doc #1588

Open
zxkane opened this issue Feb 1, 2022 · 1 comment
Open

Lots of links broken in API live doc #1588

zxkane opened this issue Feb 1, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@zxkane
Copy link

zxkane commented Feb 1, 2022

For example, the doc of GithubWorkflow.on(events), see markdown source code not hyperlink like below,

events ([github.workflows.Triggers](#projen-github-workflows-triggers)) The event(s) to trigger the workflow.
branchProtectionRule ([github.workflows.BranchProtectionRuleOptions](#projen-github-workflows-branchprotectionruleoptions)) Runs your workflow anytime the branch_protection_rule event occurs. Optional
checkRun ([github.workflows.CheckRunOptions](#projen-github-workflows-checkrunoptions)) Runs your workflow anytime the check_run event occurs. Optional
checkSuite ([github.workflows.CheckSuiteOptions](#projen-github-workflows-checksuiteoptions)) Runs your workflow anytime the check_suite event occurs. Optional
create ([github.workflows.CreateOptions](#projen-github-workflows-createoptions)) Runs your workflow anytime someone creates a branch or tag, which triggers the create event. Optional
@Chriscbr
Copy link
Contributor

Chriscbr commented Feb 4, 2022

Thanks for calling this out!

This is a bug with the old version of jsii-docgen we are using, though I'm sort of putting off upgrading it because the newer versions produce docs that are (a) much larger, and (b) do not provide a table of contents at the beginning.

(a) might be OK for now, not sure -- if not, it needs to be split into multiple pages somehow. (b) seems like a downgrade in experience, so I created a tracking issue in jsii-docgen about it (cdklabs/jsii-docgen#584)

@mrgrain mrgrain added the documentation Improvements or additions to documentation label Nov 2, 2022
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
Projects
None yet
Development

No branches or pull requests

3 participants