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: v0 の仕様書追加 ( Notion の廃止) #2

Merged
merged 17 commits into from
Jul 17, 2024
Merged

docs: v0 の仕様書追加 ( Notion の廃止) #2

merged 17 commits into from
Jul 17, 2024

Conversation

m1sk9
Copy link
Contributor

@m1sk9 m1sk9 commented Jul 16, 2024

Notion にあった仕様関連のドキュメントをすべて移行しました. アーカイブ状態だったものは移行していませんが, おそらく Out of date のものもあるため, そこを含め検証してほしいです.

  • Deno は fmt や mdbook の操作に使用しています. ( Prettier はセットアップがめんどくさい上に deno fmt は特に設定しなくても動作するため)
  • コアチームをコードオーナーに設定しました
  • Mermaid について: Mermaid を表示できるサードパーティプラグインが mdbook にはありますが, うまく動作しなかったので画像にしてからそれを別で表示するようにしました.
  • アカウントエンドポイントのリファレンスについて: ファイルサイズが大きいため GitHub の Files changed には正しく表示されないことや, テーブルが大きすぎるがために Diff では見づらいため 一度ローカルで落としてきて mdbook serve を実行しブラウザ上で見たほうがいいかもしれません
  • エンドポイントのリファレンスの型表記について: Notion では TypeScript 表記でしたが, string | boolean のような | が中に含まれているものはテーブルを破壊してしまっていたため, 型はコンマ区切りで表示するようにしました.

@m1sk9 m1sk9 marked this pull request as draft July 16, 2024 05:26
@m1sk9 m1sk9 marked this pull request as ready for review July 17, 2024 09:46
@m1sk9 m1sk9 added the T: docs Document Changes label Jul 17, 2024
src/endpoint.md Outdated Show resolved Hide resolved
src/endpoint/notes.md Outdated Show resolved Hide resolved
src/endpoint/notes.md Outdated Show resolved Hide resolved
src/endpoint/notes.md Outdated Show resolved Hide resolved
src/endpoint/notes.md Outdated Show resolved Hide resolved
src/endpoint/timeline.md Outdated Show resolved Hide resolved
src/endpoint/timeline.md Outdated Show resolved Hide resolved
src/introduction.md Outdated Show resolved Hide resolved
src/model.md Outdated Show resolved Hide resolved
src/module.md Outdated Show resolved Hide resolved
src/endpoint.md Outdated Show resolved Hide resolved
@m1sk9
Copy link
Contributor Author

m1sk9 commented Jul 17, 2024

サジェストを受け入れるので fmt は落とします.
Notion のリンクは取り除き忘れです.

Co-authored-by: Tatsuto YAMAMOTO <[email protected]>
@m1sk9
Copy link
Contributor Author

m1sk9 commented Jul 17, 2024

Fixed.
@laminne

@m1sk9 m1sk9 enabled auto-merge July 17, 2024 12:14
src/endpoint/timeline.md Outdated Show resolved Hide resolved
Co-authored-by: Tatsuto YAMAMOTO <[email protected]>
@m1sk9 m1sk9 merged commit 0012485 into main Jul 17, 2024
1 check passed
@m1sk9 m1sk9 deleted the add-v0-spec branch July 17, 2024 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: docs Document Changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants