Skip to content

Documentation generation with DocC and hosting #2

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

Merged
merged 23 commits into from
Oct 18, 2023
Merged

Conversation

Ocupe
Copy link
Contributor

@Ocupe Ocupe commented Oct 17, 2023

This PR adds automatic documentation generation using DocC. A push to main triggers a GitHub action to generate the docs and upload the artefacts to GitHub pages.

The documentation is available at the following link: https://livekit.github.io/components-swift/documentation/livekitcomponents/

@Ocupe Ocupe requested a review from noahlt October 17, 2023 12:45
@Ocupe Ocupe temporarily deployed to github-pages October 17, 2023 12:46 — with GitHub Actions Inactive
@Ocupe Ocupe requested a review from hiroshihorie October 17, 2023 12:48
Copy link
Member

@hiroshihorie hiroshihorie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice !

Copy link

@noahlt noahlt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: make this upload to Cloudflare CDN rather than GitHub Pages, and we can redirect to it in livekit-docs-site as we currently do for the existing Swift docs

@Ocupe Ocupe merged commit b4b3f20 into main Oct 18, 2023
@Ocupe Ocupe deleted the docs-gen-with-docc branch October 18, 2023 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants