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: dev docs #83

Merged
merged 6 commits into from
May 25, 2023
Merged

docs: dev docs #83

merged 6 commits into from
May 25, 2023

Conversation

diivi
Copy link
Contributor

@diivi diivi commented May 18, 2023

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

Description

Added developer documentation. For now, it explains

  • what the different files and folders are for
  • how to add/edit existing components
  • the difference between injected components and popup components, in the same file as above.

Related Tickets & Documents

#67

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
  • πŸ“ New docs folder

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

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

@diivi diivi marked this pull request as draft May 18, 2023 08:20
@diivi diivi mentioned this pull request May 23, 2023
5 tasks
@diivi diivi marked this pull request as ready for review May 24, 2023 11:23
@diivi
Copy link
Contributor Author

diivi commented May 24, 2023

@diivi diivi requested review from bdougie, BekahHW and Anush008 May 24, 2023 11:23
Copy link
Member

@Anush008 Anush008 left a comment

Choose a reason for hiding this comment

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

This is great @diivi. I've suggested 2 changes based on the recent updates to the project.

docs/1-folder-structure.md Outdated Show resolved Hide resolved
docs/1-folder-structure.md Outdated Show resolved Hide resolved
@Anush008
Copy link
Member

Documentation
The documentation for the project can be found here.

Also, can we have the README.md of the project updated to mention this folder? Currently it leads to https://docs.open.sauced.pizza. Something along the lines of, "Developer docs can be found here. Usage docs can be found here".

@diivi
Copy link
Contributor Author

diivi commented May 24, 2023

Was thinking about it, will do.

Copy link
Member

@bdougie bdougie left a comment

Choose a reason for hiding this comment

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

This needs a README as mentioned by @Anush008, but we can continuously improve.

@diivi diivi merged commit 4eff6eb into beta May 25, 2023
@diivi diivi deleted the docs/dev-docs branch May 25, 2023 09:08
github-actions bot pushed a commit that referenced this pull request May 25, 2023
## [1.2.0-beta.5](v1.2.0-beta.4...v1.2.0-beta.5) (2023-05-25)

### πŸ“ Documentation

* dev docs ([#83](#83)) ([4eff6eb](4eff6eb))
@github-actions
Copy link

πŸŽ‰ This PR is included in version 1.2.0-beta.5 πŸŽ‰

The release is available on GitHub release

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

github-actions bot pushed a commit that referenced this pull request May 25, 2023
## [1.2.0](v1.1.0...v1.2.0) (2023-05-25)

### πŸ§‘β€πŸ’» Code Refactoring

* improved-extension-navigation ([#99](#99)) ([5b2f5c1](5b2f5c1))

### πŸ“ Documentation

* dev docs ([#83](#83)) ([4eff6eb](4eff6eb))

### πŸ› Bug Fixes

* adds demo to readme ([c27e614](c27e614))
* bump manifest version on main only ([#124](#124)) ([e4a86e4](e4a86e4))
* duplicate-button-injections using guards ([#110](#110)) ([3978766](3978766))

### πŸ• Features

* add PR velocity to profile page ([#111](#111)) ([ba7fad6](ba7fad6))
* generate code suggestions via AI ([#90](#90)) ([14eede1](14eede1)), closes [#104](#104)
* Manifest.json version bump ([#120](#120)) ([488046b](488046b))
* Resources page to link users to open-sauced feedback/discussions ([#100](#100)) ([3d607ae](3d607ae))
@github-actions
Copy link

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

The release is available on GitHub release

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

zer0and1 pushed a commit to zer0and1/open-sauced.ai that referenced this pull request Jul 26, 2023
zer0and1 pushed a commit to zer0and1/open-sauced.ai that referenced this pull request Jul 26, 2023
## [1.2.0](open-sauced/ai@v1.1.0...v1.2.0) (2023-05-25)

### πŸ§‘β€πŸ’» Code Refactoring

* improved-extension-navigation ([#99](open-sauced/ai#99)) ([5b2f5c1](open-sauced/ai@5b2f5c1))

### πŸ“ Documentation

* dev docs ([#83](open-sauced/ai#83)) ([4eff6eb](open-sauced/ai@4eff6eb))

### πŸ› Bug Fixes

* adds demo to readme ([c27e614](open-sauced/ai@c27e614))
* bump manifest version on main only ([#124](open-sauced/ai#124)) ([e4a86e4](open-sauced/ai@e4a86e4))
* duplicate-button-injections using guards ([#110](open-sauced/ai#110)) ([3978766](open-sauced/ai@3978766))

### πŸ• Features

* add PR velocity to profile page ([#111](open-sauced/ai#111)) ([ba7fad6](open-sauced/ai@ba7fad6))
* generate code suggestions via AI ([#90](open-sauced/ai#90)) ([14eede1](open-sauced/ai@14eede1)), closes [#104](open-sauced/ai#104)
* Manifest.json version bump ([#120](open-sauced/ai#120)) ([488046b](open-sauced/ai@488046b))
* Resources page to link users to open-sauced feedback/discussions ([#100](open-sauced/ai#100)) ([3d607ae](open-sauced/ai@3d607ae))
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.

3 participants