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: deploy documentation site #210

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

ashleythedeveloper
Copy link
Contributor

@ashleythedeveloper ashleythedeveloper commented Aug 14, 2024

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Description

This PR adds a GitHub Actions workflow to deploy the documentation site to GitHub Pages. It also updates various documentation files to include a disclaimer about the content being under development. The PR includes configuration changes for the documentation site deployment and minor updates to the documentation structure.

Mobile & Desktop Screenshots/Recordings

Deployed site - https://uncefact.github.io/project-vckit/

Screenshot 2024-08-14 at 8 34 41β€―PM

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“œ README.md
  • πŸ““ vc-kit doc site
  • πŸ“• storybook
  • πŸ™… no documentation needed

Copy link

github-actions bot commented Aug 14, 2024

Coverage report

Caution

Coverage does not meet threshold
Statements coverage not met for global: expected <=25 not covered statements, but got 0

St.❔
Category Percentage Covered / Total
🟒 Statements 100% 0/0
🟒 Branches 100% 0/0
🟒 Functions 100% 0/0
🟒 Lines 100% 0/0

Test suite run success

0 tests passing in 0 suite.

Report generated by πŸ§ͺjest coverage report action from bcefa0d

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.

1 participant