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: update docs based on recent changes to product #301

Merged
merged 42 commits into from
May 17, 2024

Conversation

BekahHW
Copy link
Member

@BekahHW BekahHW commented May 8, 2024

Description

  • reflects highlight change to general blog posts
  • Adds sample queries for starsearch

Related Tickets & Documents

closes #296
closes #248

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] What gif best describes this PR or how it makes you feel?

@BekahHW BekahHW requested a review from a team as a code owner May 8, 2024 18:42
Copy link

netlify bot commented May 8, 2024

Deploy Preview for docs-open ready!

Name Link
🔨 Latest commit 2aceeba
🔍 Latest deploy log https://app.netlify.com/sites/docs-open/deploys/6647a212fb33b000080756e9
😎 Deploy Preview https://deploy-preview-301--docs-open.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@BekahHW BekahHW marked this pull request as draft May 8, 2024 18:43
Copy link
Member

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

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

Hey @BekahHW,

I understand that this is still a draft. But I left reviews here to save you time. So, I hope you don't mind!
Some need to be addressed, but most are suggestions. 🙂

Thank you!

docs/features/repo-pages.md Outdated Show resolved Hide resolved
docs/features/repo-pages.md Outdated Show resolved Hide resolved
docs/features/repo-pages.md Outdated Show resolved Hide resolved
docs/features/repo-pages.md Outdated Show resolved Hide resolved
docs/features/repo-pages.md Outdated Show resolved Hide resolved
docs/features/star-search.md Outdated Show resolved Hide resolved
docs/features/star-search.md Outdated Show resolved Hide resolved
docs/features/workspaces.md Outdated Show resolved Hide resolved
docs/features/workspaces.md Outdated Show resolved Hide resolved
docs/welcome/glossary.md Outdated Show resolved Hide resolved
@BekahHW BekahHW marked this pull request as ready for review May 17, 2024 14:15
Copy link
Member

@nickytonline nickytonline left a comment

Choose a reason for hiding this comment

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

Thanks Bekah! 🚢

Copy link
Member

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

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

@BekahHW I left some small things here and this is ready to go. 😊

docs/features/repo-pages.md Outdated Show resolved Hide resolved
docs/features/star-search.md Outdated Show resolved Hide resolved
docs/features/star-search.md Outdated Show resolved Hide resolved
docs/features/workspaces.md Outdated Show resolved Hide resolved
docs/features/workspaces.md Outdated Show resolved Hide resolved
docs/welcome/glossary.md Outdated Show resolved Hide resolved
Copy link
Member

@nickytonline nickytonline left a comment

Choose a reason for hiding this comment

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

Left a couple comments

@BekahHW
Copy link
Member Author

BekahHW commented May 17, 2024

@adiati98, I updated and added in your comments except for the nav bar, which I wrote navigation bar. If there's nothing super big, could you approve and merge and we can handle anything else in a separate issue?

@adiati98 adiati98 merged commit bcc2750 into main May 17, 2024
11 checks passed
@adiati98 adiati98 deleted the feat/updates-for-PH branch May 17, 2024 18:54
github-actions bot pushed a commit that referenced this pull request May 17, 2024
* Add some new query suggestions

* Remove Dev.to specification for blog posts

* Fix link in repo pages and add new metrics

* Add Activity Ratio to glossary

* Add link to courses in community section

* Add lottery factor to glossary

* Update to lottery and clarify

* Add more detailed documentation for repo pages

* Add an FAQs section to starsearch

* Update repo page img

* Add new img

* Add information on the PR and issue tables

* Escape formatting

* Escape formatting

* Update docs/features/repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/star-search.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/workspaces.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/workspaces.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/welcome/glossary.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Remove tip

* Update description of StarSearch

* Update queries to the questions we're focusing on

* Add feedback section and fix typo

* Clarify descriptions for StarSearch

* Clarify lottery factor

* Clarify contributor dashboard

* Update docs/features/repo-pages.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/star-search.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/workspaces.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/welcome/glossary.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update starsearch for clarification

* Cap workspace

* Add PR specification to lottery factor

* fix workspace id

* Handle case sensitivity in links

---------

Co-authored-by: Ayu Adiati <[email protected]> bcc2750
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.

feat: Add activity dashboard to workspace docs Clarify health metrics in workspaces
3 participants