README draft #14

AkifumiSato · 2023-09-15T12:14:47Z

リポジトリのREADME作成

参考

README.md

changeset-bot · 2023-09-18T12:51:53Z

⚠️ No Changeset found

Latest commit: 8247dd0

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 changesets to release 2 packages

Name	Type
@location-state/core	Major
@location-state/next	Major

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

AkifumiSato · 2023-09-18T13:28:23Z

packages/location-state-core/README.md

@@ -0,0 +1,31 @@
+# @location-state/core


coreの方のREADME構成も追加してみました。
前半は被ってしまうけどnpmのサイトにも載るのでほぼ同じでも書くべきかと思って載せてます。
Advanced usageはそこそこ長くなってしまう気がしてて、別ドキュメントにしてリンクだけ貼っとくべきか悩んでます。

それぞれのパッケージのREADME.mdはトップのやつのコピペでもいいかもですね
そしてAPIドキュメントは別ファイルでも構わないかな
Advanced Usageは最初からなくてもいいかなぁ
どうせAPIリファレンスに必要な情報は出てくるし

あと先頭付近の一行説明についてはこちらも
#6 (comment)

この1行説明をリポジトリに反映するのはどこでやるんだろう？
リポジトリ一覧を見るとrecoil-sync-nextには説明があるけどlocation-stateにはない。。。？
https://github.com/orgs/recruit-tech/repositories

Github上のAboutで設定できるので、追加しておきました。

構成忘れそうなので、一旦API.mdをTBWで作成してcoreとnextそれぞれのREADMEからリンクだけ貼ってみました。
0257c7a

それぞれのパッケージのREADME.mdはトップのやつのコピペでもいいかもですね

それぞれタイトル変えるくらいなイメージだったので一旦それで置いてみましたが、どうでしょう？
@location-state/nextの方はpages routerのquick startだけでいいかなと思ったものの、App Routerどうするかも書いておくべき≒やはりほぼ同じ内容であるべきなのか悩んで、意見聞いてからにしようかと思い...

コピペと書いたのはよくなかったですね、@location-state/coreのREADMEにはPages Routerの使い方は要らなくて、@location-state/nextのREADMEにはApp Routerの使い方は要らないと思います

@location-state/coreのREADMEにはPages Routerの使い方は要らなくて、@location-state/nextのREADMEにはApp Routerの使い方は要らないと思います

↑のように一部削除しました。
418bcfc

オッケーでーす
日本語になってるところをDeepLでもなんでもいいので英語化しましょう

deeplしました！
4f61ad6

# Conflicts: # packages/location-state-core/package.json # packages/location-state-next/package.json

AkifumiSato · 2023-09-22T06:43:38Z

chagesets修正してmajorにしました
9380fd7

koichik

コミットにコメントしたけどコミット自体が古くなってたようなので改めてコメントしなおし
なんか日本語の段階でもう少し精査すべきだった。。。というかその時点でDeepLしておけばよかったのか？

koichik · 2023-09-22T10:23:32Z

README.md


 ## Features

-TBW
+- You can manage the state linked to the history location.


ライブラリのFeaturesなのに「You can ～」は微妙かなぁ。。。
その点は日本語の時点で気付くべきだったか
つまり誰かが「行うことができる」ではなくライブラリが「何をする」あるいは「何をしてくれる」という表現にすべきだった
あと「連動する」はlinkedになるのね、、、linke(d)はこの世界だとlinked listとかlinkerとかで使われるように結びつきが強い場合に選ばれる印象
なのでここは日本語の段階で「同期する」にすべきだったか
合わせると「履歴位置に同期する状態を管理する」となり、DeepLしてちょっと調整 (positionをlocationに) すると

Manage the state to synchronize with the history location.

となり、この方が自然かなと
1行紹介と違いがない気がしなくもないけど！

なるほどです！
修正しました。
8247dd0

koichik · 2023-09-22T10:23:40Z

README.md


 ## Features

-TBW
+- You can manage the state linked to the history location.
+- By default, Session Storage/URL can be specified as the destination.


こっちも同様にライブラリが何をしてくれるかという観点と、destinationだけだとなんのdestinationか分かりにくいので「デフォルトでは、永続先としてSession StorageとURLをサポートする」としてからDeepLすると

By default, supports Session Storage and URL as persistent destinations.

修正しました。
8247dd0

koichik

ちょっと追加

koichik · 2023-09-22T10:28:11Z

.changeset/breezy-penguins-boil.md

-"@location-state/core": patch
-"@location-state/next": patch
+"@location-state/core": major
+"@location-state/next": major
 ---

 Initial construction of the package.


これも微妙だなー
constructionっていうとシステムとかの構築では使ってもライブラリで使うんだっけ？という疑問が (というかまず見かけない気がする)
ここはシンプルに「Initial release.」でいいかなぁ

修正しました。
8247dd0

koichik · 2023-09-22T10:29:27Z

README.md

+[![npm version](https://badge.fury.io/js/@location-state%2Fcore.svg)](https://badge.fury.io/js/@location-state%2Fcore)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+State management library for React that synchronizes with history entries supporting Next.js App Router.


history entriesとhistory locationが混在するのも気になるので一行紹介もhistory locationに揃えましょうか

修正しました。
8247dd0

koichik · 2023-09-22T10:30:37Z

README.md

+export function Providers({ children }: { children: React.ReactNode }) {
+  return <LocationStateProvider>{children}</LocationStateProvider>;
+}
+


ここでファイルが変わるのでコードブロックも区切りましょうか

修正しました。
8247dd0

koichik

乙！ LGTM！！！

AkifumiSato requested a review from koichik September 15, 2023 12:14

AkifumiSato force-pushed the readme branch from d3af14d to 531e85c Compare September 15, 2023 12:17

AkifumiSato commented Sep 15, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

AkifumiSato changed the title ~~README.ms first draft~~ README draft Sep 15, 2023

AkifumiSato mentioned this pull request Sep 17, 2023

pre release ci #4

Closed

AkifumiSato commented Sep 18, 2023

View reviewed changes

AkifumiSato and others added 9 commits September 22, 2023 15:41

README.ms first draft

a77f762

update root README: structure, used on Next.js

4d16e23

Simple explanation of functions

eb431d9

# Conflicts: # packages/location-state-core/package.json # packages/location-state-next/package.json

add core README

b9e6509

update README

e7d84b8

# Conflicts: # packages/location-state-core/package.json # packages/location-state-next/package.json

update README and package description.

b08356e

# Conflicts: # packages/location-state-core/package.json # packages/location-state-next/package.json

fix contents of each quickstart

4a70810

translation

4f61ad6

update changeset specified version

9380fd7

AkifumiSato force-pushed the readme branch from e4d3c8f to 9380fd7 Compare September 22, 2023 06:42

AkifumiSato marked this pull request as ready for review September 22, 2023 07:07

koichik reviewed Sep 22, 2023

View reviewed changes

fix README wording

8247dd0

koichik approved these changes Sep 22, 2023

View reviewed changes

AkifumiSato merged commit dc68ac6 into main Sep 22, 2023
2 checks passed

AkifumiSato deleted the readme branch September 22, 2023 11:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README draft #14

README draft #14

AkifumiSato commented Sep 15, 2023 •

edited

Loading

changeset-bot bot commented Sep 18, 2023 •

edited

Loading

AkifumiSato Sep 18, 2023

koichik Sep 18, 2023

koichik Sep 18, 2023

koichik Sep 18, 2023

AkifumiSato Sep 19, 2023

AkifumiSato Sep 19, 2023

koichik Sep 19, 2023

AkifumiSato Sep 21, 2023

koichik Sep 21, 2023

AkifumiSato Sep 22, 2023

AkifumiSato commented Sep 22, 2023

koichik left a comment •

edited

Loading

koichik Sep 22, 2023

AkifumiSato Sep 22, 2023

koichik Sep 22, 2023

AkifumiSato Sep 22, 2023

koichik left a comment

koichik Sep 22, 2023

AkifumiSato Sep 22, 2023

koichik Sep 22, 2023

AkifumiSato Sep 22, 2023

koichik Sep 22, 2023

AkifumiSato Sep 22, 2023

koichik left a comment

README draft #14

README draft #14

Conversation

AkifumiSato commented Sep 15, 2023 • edited Loading

参考

changeset-bot bot commented Sep 18, 2023 • edited Loading

⚠️ No Changeset found

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AkifumiSato commented Sep 22, 2023

koichik left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koichik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koichik left a comment

Choose a reason for hiding this comment

AkifumiSato commented Sep 15, 2023 •

edited

Loading

changeset-bot bot commented Sep 18, 2023 •

edited

Loading

koichik left a comment •

edited

Loading