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(suspensive.org): add docs for @suspensive/jotai #1084

Merged
merged 27 commits into from
Jul 18, 2024
Merged

Conversation

gwansikk
Copy link
Collaborator

@gwansikk gwansikk commented Jul 14, 2024

Overview

Roadmap

  • motivation
  • installation
  • Atom
  • AtomValue
  • SetAtom
  • Translate

PR Checklist

  • I did below actions if need
  1. I read the Contributing Guide
  2. I added documents and tests.

@gwansikk gwansikk linked an issue Jul 14, 2024 that may be closed by this pull request
Copy link

changeset-bot bot commented Jul 14, 2024

⚠️ No Changeset found

Latest commit: 404b9b2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jul 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2024 11:17am
v1.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2024 11:17am
visualization.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2024 11:17am

Copy link

codspeed-hq bot commented Jul 14, 2024

CodSpeed Performance Report

Merging #1084 will create unknown performance changes

Comparing docs/feat/jotai (404b9b2) with main (c591968)

Summary

⚠️ No benchmarks were detected in both the base of the PR and the PR.

@codecov-commenter
Copy link

codecov-commenter commented Jul 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.99%. Comparing base (c591968) to head (404b9b2).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1084   +/-   ##
=======================================
  Coverage   85.99%   85.99%           
=======================================
  Files          64       64           
  Lines         664      664           
  Branches      138      139    +1     
=======================================
  Hits          571      571           
  Misses         88       88           
  Partials        5        5           
Components Coverage Δ
@suspensive/react 97.05% <ø> (ø)
@suspensive/react-query 75.28% <ø> (ø)
@suspensive/react-query-4 0.00% <ø> (ø)
@suspensive/react-query-5 0.00% <ø> (ø)
@suspensive/jotai 0.00% <ø> (ø)
@suspensive/cache 98.16% <ø> (ø)
@suspensive/react-await 100.00% <ø> (ø)
@suspensive/react-image 80.39% <ø> (ø)

gwansikk and others added 2 commits July 14, 2024 22:15
Co-authored-by: jgjgill <79239852+jgjgill@users.noreply.github.com>
Co-authored-by: 김석진(poki) <102217654+SEOKKAMONI@users.noreply.github.com>
Copy link
Member

@manudeli manudeli left a comment

Choose a reason for hiding this comment

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

I left some reviews to improve intuitivity

@gwansikk gwansikk marked this pull request as draft July 15, 2024 13:54
@gwansikk
Copy link
Collaborator Author

@manudeli @SEOKKAMONI Could you provide feedback on the updated documentation? I'm curious if you have any better ideas for the examples.

Copy link
Member

@manudeli manudeli left a comment

Choose a reason for hiding this comment

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

Almost done..!

docs/suspensive.org/src/pages/docs/jotai/Atom.ko.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@SEOKKAMONI SEOKKAMONI left a comment

Choose a reason for hiding this comment

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

The comments below are suggestions, so you don't have to incorporate them if you don't want to!

Copy link
Member

@manudeli manudeli left a comment

Choose a reason for hiding this comment

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

After this, Let's improve this doc gradually if need

@manudeli manudeli merged commit 78f9e1f into main Jul 18, 2024
16 checks passed
@manudeli manudeli deleted the docs/feat/jotai branch July 18, 2024 00:00
manudeli added a commit that referenced this pull request Aug 3, 2024
# Overview

### Roadmap

- [x] motivation
- [x] installation
- [x] Atom
- [x] AtomValue
- [x] SetAtom
- [x] Translate

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: jgjgill <79239852+jgjgill@users.noreply.github.com>
Co-authored-by: 김석진(poki) <102217654+SEOKKAMONI@users.noreply.github.com>
Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
Co-authored-by: Jonghyeon Ko <61593290+manudeli@users.noreply.github.com>
manudeli pushed a commit that referenced this pull request Aug 3, 2024
# Overview

### Roadmap

- [x] motivation
- [x] installation
- [x] Atom
- [x] AtomValue
- [x] SetAtom
- [x] Translate

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------
manudeli added a commit that referenced this pull request Aug 3, 2024
# Overview

### Roadmap

- [x] motivation
- [x] installation
- [x] Atom
- [x] AtomValue
- [x] SetAtom
- [x] Translate

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: jgjgill <79239852+jgjgill@users.noreply.github.com>
Co-authored-by: 김석진(poki) <102217654+SEOKKAMONI@users.noreply.github.com>
Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
Co-authored-by: Jonghyeon Ko <61593290+manudeli@users.noreply.github.com>
manudeli added a commit that referenced this pull request Aug 3, 2024
# Overview

### Roadmap

- [x] motivation
- [x] installation
- [x] Atom
- [x] AtomValue
- [x] SetAtom
- [x] Translate

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------

Co-authored-by: jgjgill <79239852+jgjgill@users.noreply.github.com>
Co-authored-by: 김석진(poki) <102217654+SEOKKAMONI@users.noreply.github.com>
Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
Co-authored-by: Jonghyeon Ko <61593290+manudeli@users.noreply.github.com>
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.

[Feature]: Docs for @suspensive/jotai
5 participants