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: generated api docs #3420

Merged
merged 77 commits into from
May 5, 2023
Merged

docs: generated api docs #3420

merged 77 commits into from
May 5, 2023

Conversation

adamdbradley
Copy link
Contributor

@adamdbradley adamdbradley commented Mar 17, 2023

API Reference

Preview: https://0e2afa6e.qwik-docs.pages.dev/docs/ and click on the "API" button

Know issues

  • anchors are not always working (eg. qwik -> $ since the dollar sign is stripped away for .md file anchors)

@stackblitz
Copy link

stackblitz bot commented Mar 17, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@cloudflare-pages
Copy link

cloudflare-pages bot commented Mar 17, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: c86c47d
Status: ✅  Deploy successful!
Preview URL: https://4a427c00.qwik-docs.pages.dev
Branch Preview URL: https://api-docs.qwik-docs.pages.dev

View logs

@zanettin zanettin added the COMP: docs Improvements or additions to documentation label Mar 31, 2023
scripts/api-docs.ts Fixed Show fixed Hide fixed
scripts/api-docs.ts Fixed Show fixed Hide fixed
scripts/api-docs.ts Fixed Show fixed Hide fixed
scripts/api-docs.ts Fixed Show fixed Hide fixed
@gitguardian
Copy link

gitguardian bot commented Apr 14, 2023

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
Once a secret has been leaked into a git repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

scripts/api-docs.ts Dismissed Show dismissed Hide dismissed
scripts/api-docs.ts Dismissed Show dismissed Hide dismissed
@adamdbradley adamdbradley marked this pull request as ready for review May 5, 2023 15:30
@adamdbradley adamdbradley merged commit 76f9a68 into main May 5, 2023
22 checks passed
@adamdbradley adamdbradley deleted the api-docs branch May 5, 2023 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
COMP: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants