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 new structure #2900

Merged
merged 9 commits into from
Nov 27, 2023
Merged

Docs new structure #2900

merged 9 commits into from
Nov 27, 2023

Conversation

martinmitrevski
Copy link
Contributor

@martinmitrevski martinmitrevski commented Nov 17, 2023

🔗 Issue Links

Provide all Jira tickets and/or Github issues related to this PR, if applicable.

🎯 Goal

Describe why we are making this change.

📝 Summary

Provide bullet points with the most important changes in the codebase.

🛠 Implementation

Provide a detailed description of the implementation and explain your decisions if you find them relevant.

🎨 Showcase

Add relevant screenshots and/or videos/gifs to easily see what this PR changes, if applicable.

Before After
img img

🧪 Manual Testing Notes

Run docusaurus locally:

npx stream-chat-docusaurus -i -s

☑️ Contributor Checklist

  • I have signed the Stream CLA (required)
  • This change follows zero ⚠️ policy (required)
  • This change should be manually QAed
  • Changelog is updated with client-facing changes
  • New code is covered by unit tests
  • Comparison screenshots added for visual changes
  • Affected documentation updated (docusaurus, tutorial, CMS)

🎁 Meme

Provide a funny gif or image that relates to your work on this pull request. (Optional)

@martinmitrevski martinmitrevski requested a review from a team as a code owner November 17, 2023 16:52
@martinmitrevski martinmitrevski marked this pull request as draft November 17, 2023 16:52
Copy link

github-actions bot commented Nov 17, 2023

1 Warning
⚠️ Please be sure to complete the Contributor Checklist in the Pull Request description

Generated by 🚫 Danger

Copy link
Contributor

@testableapple testableapple left a comment

Choose a reason for hiding this comment

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

LGTM, just a couple of comment regarding the Installation page

Comment on lines 2 to 5
title: Integration
title: Installation
---

# Integration
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Would be nice to update the h1 (#) from # Integration to # Installation
  • Would be nice to update the text check our Integration page on the pages /chat/docs/sdk/ios/client/, /chat/docs/sdk/ios/uikit/ and /chat/docs/sdk/ios/swiftui/
  • Do we need to update the file name as well? If so, keep in mind that there are a lot of references across the docs and Readme.

@martinmitrevski martinmitrevski marked this pull request as ready for review November 27, 2023 13:34
@martinmitrevski martinmitrevski merged commit de09482 into develop Nov 27, 2023
14 checks passed
@martinmitrevski martinmitrevski deleted the docs-new-structure branch November 27, 2023 20:09
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.

2 participants