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

chore: revamp platform docs #17117

Merged
merged 8 commits into from
Oct 15, 2024
Merged

chore: revamp platform docs #17117

merged 8 commits into from
Oct 15, 2024

Conversation

Ryukemeister
Copy link
Contributor

@Ryukemeister Ryukemeister commented Oct 15, 2024

What does this PR do?

  • Revamped platform docs a bit, now each has a page of its own.
Screen.Recording.2024-10-15.at.6.46.56.PM.mov

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

  • Are there environment variables that should be set?
  • What are the minimal test data to have?
  • What is expected (happy path) to have (input and output)?
  • Any other important info that could help to test that PR

Checklist

  • I haven't read the contributing guide
  • My code doesn't follow the style guidelines of this project
  • I haven't commented my code, particularly in hard-to-understand areas
  • I haven't checked if my changes generate no new warnings

@dosubot dosubot bot added docs area: docs, documentation, cal.com/docs platform Anything related to our platform plan labels Oct 15, 2024
@graphite-app graphite-app bot requested a review from a team October 15, 2024 13:15
@keithwillcode keithwillcode added the core area: core, team members only label Oct 15, 2024
Copy link

graphite-app bot commented Oct 15, 2024

Graphite Automations

"Add platform team as reviewer" took an action on this PR • (10/15/24)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add ready-for-e2e label" took an action on this PR • (10/15/24)

1 label was added to this PR based on Keith Williams's automation.

<iframe
width="560"
height="315"
src="https://www.loom.com/embed/0db65d94754443ae91fed28f9bc10509?sid=d7b823cc-cda1-4d18-881a-aa49242b873d"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This needs to be fixed, im waiting for the correct loom to be uploaded.

supalarry
supalarry previously approved these changes Oct 15, 2024
Copy link
Contributor

@supalarry supalarry left a comment

Choose a reason for hiding this comment

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

Great work Rajiv!

Copy link
Contributor

github-actions bot commented Oct 15, 2024

E2E results are ready!

Copy link

vercel bot commented Oct 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
cal ⬜️ Ignored (Inspect) Visit Preview Oct 15, 2024 2:56pm
calcom-web-canary ⬜️ Ignored (Inspect) Visit Preview Oct 15, 2024 2:56pm

@Ryukemeister
Copy link
Contributor Author

Need to fix a couple of links, getting loom videos for that so don't merge this yet.

@Ryukemeister
Copy link
Contributor Author

Alright safe to merge this now!

@Ryukemeister Ryukemeister enabled auto-merge (squash) October 15, 2024 14:55
@Ryukemeister Ryukemeister merged commit c21f0ca into main Oct 15, 2024
36 of 37 checks passed
@Ryukemeister Ryukemeister deleted the restructure-platform-docs branch October 15, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core area: core, team members only docs area: docs, documentation, cal.com/docs platform Anything related to our platform plan ready-for-e2e
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants