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

feat: Add repo pages #293

Merged
merged 6 commits into from
Apr 10, 2024
Merged

feat: Add repo pages #293

merged 6 commits into from
Apr 10, 2024

Conversation

BekahHW
Copy link
Member

@BekahHW BekahHW commented Apr 10, 2024

Description

Add repo pages docs

Related Tickets & Documents

closes #285

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

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

[optional] Are there any post-deployment tasks we need to perform?

[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 April 10, 2024 19:52
Copy link

netlify bot commented Apr 10, 2024

Deploy Preview for docs-open ready!

Name Link
🔨 Latest commit 75cd366
🔍 Latest deploy log https://app.netlify.com/sites/docs-open/deploys/6616f5108b60910008e654ab
😎 Deploy Preview https://deploy-preview-293--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 merged commit 3143b02 into main Apr 10, 2024
11 checks passed
@BekahHW BekahHW deleted the feature/repo-pages branch April 10, 2024 20:23
github-actions bot pushed a commit that referenced this pull request Apr 10, 2024
## [1.71.0](v1.70.0...v1.71.0) (2024-04-10)

### Features

* Add repo pages ([#293](#293)) ([3143b02](3143b02))
Copy link
Contributor

🎉 This PR is included in version 1.71.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot pushed a commit that referenced this pull request Apr 10, 2024
* Add repo pages

* Finish repo pages docs

* Remame img

* Revise docs

* Formatting and linking 3143b02
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 PR is already merged. But I have some questions here if we want to edit the docs in near future.

Thanks!

title: "Check out Repository Activity"
sidebar_label: "Repository Pages"
keywords:
- "repository pages"
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to keep consistency by using capitalization across docs for keywords? Or how would it be?

Suggested change
- "repository pages"
- "Repository Pages"


`https://app.opensauced.pizza/s/{org}/{repo}`

Replace {org} with the name of the organization that owns the repository you want to view. Replace {repo} with the name of the specific repository.
Copy link
Member

Choose a reason for hiding this comment

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

We might want to use backticks for these.

Suggested change
Replace {org} with the name of the organization that owns the repository you want to view. Replace {repo} with the name of the specific repository.
Replace `{org}` with the name of the organization that owns the repository you want to view. Replace `{repo}` with the name of the specific repository.


Currently, only publicly available repositories on GitHub can be viewed through Open Sauced Pizza's repository pages.

Repository pages on Open Sauced Pizza provide a way to explore and learn about open source code repositories hosted on GitHub. While you cannot create or edit them directly on Open Sauced Pizza yet, you can add them to your [Repository Insight pages](https://docs.opensauced.pizza/features/repo-insights/).
Copy link
Member

@adiati98 adiati98 Apr 11, 2024

Choose a reason for hiding this comment

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

  • Should this be "OpenSauced" or "Open Sauced" is already correct"?
  • question: We capitalize the word "Page" that follows our feature across the docs. Just for my future reference, for plural, will we keep it lowercase? The examples here are Repository pages and Repository Insight pages.
Suggested change
Repository pages on Open Sauced Pizza provide a way to explore and learn about open source code repositories hosted on GitHub. While you cannot create or edit them directly on Open Sauced Pizza yet, you can add them to your [Repository Insight pages](https://docs.opensauced.pizza/features/repo-insights/).
Repository pages on OpenSauced Pizza provide a way to explore and learn about open source code repositories hosted on GitHub. While you cannot create or edit them directly on OpenSauced Pizza yet, you can add them to your [Repository Insight pages](https://docs.opensauced.pizza/features/repo-insights/).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Add Repo Pages to Docs
2 participants