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: Reorganize docs #201

Merged
merged 27 commits into from Nov 6, 2023
Merged

feat: Reorganize docs #201

merged 27 commits into from Nov 6, 2023

Conversation

BekahHW
Copy link
Member

@BekahHW BekahHW commented Nov 1, 2023

Description

Reorganizes documentation to provide a clearer path for users.

  • Two new sections: Features (insights, lists, highlights, connections, dev card) and Tools (CLI, hot, chrome extension).
  • Removes files that are no longer useful
  • Moves the technical section within the Contributing section
  • Updates overview to provide a clearer description for OpenSauced

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

Related Tickets & Documents

closes #199

Mobile & Desktop Screenshots/Recordings

Added tests?

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

Added to documentation?

  • πŸ“œ README.md
  • πŸ““ docs.opensauced.pizza
  • πŸ• dev.to/opensauced
  • πŸ“• storybook
  • πŸ™… no documentation needed

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

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

Copy link

netlify bot commented Nov 1, 2023

βœ… Deploy Preview for docs-open ready!

Name Link
πŸ”¨ Latest commit 029ffa3
πŸ” Latest deploy log https://app.netlify.com/sites/docs-open/deploys/6543ace936099e0008d9eb5c
😎 Deploy Preview https://deploy-preview-201--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 ready for review November 2, 2023 13:45
@BekahHW BekahHW requested a review from CBID2 November 2, 2023 16:50
@BekahHW
Copy link
Member Author

BekahHW commented Nov 2, 2023

@CBID2 would you mind running this locally and just make sure it works. There's no major content changes yet. That will come after this PR is merged in.

@BekahHW BekahHW merged commit dc12081 into main Nov 6, 2023
16 checks passed
@BekahHW BekahHW deleted the feature/reorg branch November 6, 2023 18:12
github-actions bot pushed a commit that referenced this pull request Nov 6, 2023
## [1.50.0](v1.49.0...v1.50.0) (2023-11-06)

### Features

* Reorganize docs ([#201](#201)) ([dc12081](dc12081))
Copy link

github-actions bot commented Nov 6, 2023

πŸŽ‰ This PR is included in version 1.50.0 πŸŽ‰

The release is available on:

Your semantic-release bot πŸ“¦πŸš€

github-actions bot pushed a commit that referenced this pull request Nov 6, 2023
* Add tools section and pizza CLI

* Add features section

* Add lists to features

* Small fixes

* Copy updates

* Update links to go to the right place

* Move technical into contributing folder

* Rename Pizza-cli

* Move maintainers guide to contributing

* Rename maintainers to opensauced-packages

* Update the sidebar to reflect file moves and name changes

* Change a couple folders to collapsed

* Remove section about not resolving merge conflicts in GH editor

* Update image paths

* Update image path in pr-description

* Remove repetitive file

* Remove deleted file from sidebar

* Update path for refactoring and testing

* Update paths for viewing insights and invitations

* Change twitter to X

* Add link to yt demos

* Change title to learN

* Remove setting up a new repo

* Remove deleted resource from sidebar

* Add a link to intro course in learn section

* Remove extra apostrophe dc12081
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: reorganize docs
2 participants