From 3739638c816055add4b4c3f17bcfa507474e48c5 Mon Sep 17 00:00:00 2001 From: syuilo Date: Fri, 6 Aug 2021 03:28:47 +0900 Subject: [PATCH] Improve docs --- src/client/pages/doc.vue | 18 ++++++++++++++++++ src/docs/ja-JP/features/antenna.md | 4 ++++ src/docs/ja-JP/features/drive.md | 9 +++++++++ src/docs/ja-JP/features/note.md | 14 ++++++++------ src/docs/ja-JP/general/misskey.md | 5 +++-- src/docs/ja-JP/general/troubleshooting.md | 3 ++- 6 files changed, 44 insertions(+), 9 deletions(-) create mode 100644 src/docs/ja-JP/features/antenna.md diff --git a/src/client/pages/doc.vue b/src/client/pages/doc.vue index 8647b0a44..017211036 100644 --- a/src/client/pages/doc.vue +++ b/src/client/pages/doc.vue @@ -208,6 +208,24 @@ export default defineComponent({ padding: 0; } } + + ::v-deep(.info) { + font-size: 90%; + background: var(--infoBg); + color: var(--infoFg); + padding: 1em; + margin: 0.75em 0; + border-radius: 6px; + } + + ::v-deep(.warn) { + font-size: 90%; + background: var(--infoWarnBg); + color: var(--infoWarnFg); + padding: 1em; + margin: 0.75em 0; + border-radius: 6px; + } } > .footer { diff --git a/src/docs/ja-JP/features/antenna.md b/src/docs/ja-JP/features/antenna.md new file mode 100644 index 000000000..94ad9e4ae --- /dev/null +++ b/src/docs/ja-JP/features/antenna.md @@ -0,0 +1,4 @@ +# アンテナ +アンテナは、自由に条件を設定して、合致するノートを自動で収集することができる機能です。 + +条件を設定したアンテナが作成された状態で、条件に合致するノートが投稿されると、リアルタイムでそのアンテナのタイムラインにノートが追加されます。 diff --git a/src/docs/ja-JP/features/drive.md b/src/docs/ja-JP/features/drive.md index d169b7f54..784fb492e 100644 --- a/src/docs/ja-JP/features/drive.md +++ b/src/docs/ja-JP/features/drive.md @@ -6,3 +6,12 @@ ドライブにアップロードされたファイルは、いつでもダウンロードすることができるほか、ノート作成時に「ドライブからファイルを添付」することでファイルを再利用することもできます。 ドライブ内にフォルダを作り、複数のファイルをまとめて整理することもできます。 + +## 閲覧注意 (NSFW) +
ℹ️ この項目が閲覧注意なわけではありません
+ +閲覧注意またはNSFW (Not safe for work) は、ドライブのファイルに設定することができるフラグです。 +閲覧注意フラグを設定されたファイルは、表示される際に閲覧者の操作なしには表示されなくなります。 +このフラグは、例えば職場や公共の場で閲覧するのに適切でないと思われる画像などに設定し、そのような画像が突然表示されてしまうことを防ぐ目的で使われます。 + +このフラグは手動でオンオフを切り替えられるほか、モデレーターの判断で設定される場合もあります。 diff --git a/src/docs/ja-JP/features/note.md b/src/docs/ja-JP/features/note.md index 00bfbf59f..45fbbbfc3 100644 --- a/src/docs/ja-JP/features/note.md +++ b/src/docs/ja-JP/features/note.md @@ -3,15 +3,17 @@ ノートが作成されると、[タイムライン](./timeline)に追加され、自分の[フォロワー](./follow)やサーバーのユーザーが見れるようになります。 -ノートを作成するには、画面上にある鉛筆マークのボタンを押して、作成フォームを開きます。作成フォームに内容を入力し、「ノート」ボタンを押すことでノートが作成されます。 -ノートには、画像、動画など任意のファイルや、[アンケート](./poll)を添付することができます。また、本文中には[MFM](./mfm)が使用でき、[メンション](./mention)や[ハッシュタグ](./hashtag)を含めることもできます。 -他にも、CWや公開範囲といった設定も行えます(詳細は後述)。 -コンピューターのクリップボードに画像データがある状態で、フォーム内のテキストボックスにペーストするとその画像を添付することができます。 - ノートには、[リアクション](./reaction)を行うことができます。また、返信や引用もできます。 ノートを[お気に入り](./favorite)登録することで、後で簡単に見返すことができます。 +## ノートを作成する +ノートを作成するには、画面上にある鉛筆マークのボタンを押して、作成フォームを開きます。作成フォームに内容を入力し、「ノート」ボタンを押すことでノートが作成されます。 +ノートには、画像、動画など任意のファイルや、[アンケート](./poll)を添付することができます。また、本文中には[MFM](./mfm)が使用でき、[メンション](./mention)や[ハッシュタグ](./hashtag)を含めることもできます。 +他にも、CWや公開範囲といった設定も行えます(詳細は後述)。 +
ℹ️ コンピューターのクリップボードに画像データがある状態で、フォーム内のテキストボックスにペーストするとその画像を添付することができます。
+
ℹ️ テキストボックス内でCtrl + Enterを押すことでも投稿できます。
+ ## Renote 既にあるノートを引用、もしくはそのノートを新しいノートとして共有する行為、またそれによって作成されたノートをRenoteと呼びます。 自分がフォローしているユーザーの、気に入ったノートを自分のフォロワーに共有したい場合や、過去の自分のノートを再度共有したい場合に使います。 @@ -26,7 +28,7 @@ Contents Warningの略で、ノートの内容を、閲覧者の操作なしに ### パブリック 全ての人に対してノートが公開されるほか、サーバーの全てのタイムライン(ホームタイムライン、ローカルタイムライン、ソーシャルタイムライン、グローバルタイムライン)にノートが流れます。 -アカウントが[サイレンス](./silence)状態の時は、この公開範囲は使用できません。 +
⚠️ アカウントがサイレンス状態の時は、この公開範囲は使用できません。
### ホーム 全ての人に対してノートが公開されますが、フォロワー以外のローカルタイムライン、ソーシャルタイムライン、グローバルタイムラインにはノートは流れません。 diff --git a/src/docs/ja-JP/general/misskey.md b/src/docs/ja-JP/general/misskey.md index 7a50040ad..209f7ce26 100644 --- a/src/docs/ja-JP/general/misskey.md +++ b/src/docs/ja-JP/general/misskey.md @@ -7,7 +7,7 @@ Misskeyはオープンソースの分散型マイクロブログプラットフ ## 歴史 開発当初は掲示板がメインのサービスでしたが、ユーザーが短文を投稿し、それを時系列で流れるタイムライン機能を追加したところ人気が高まり、徐々にそれがメインとして開発が進むようになりました。 当初は分散型ではありませんでしたが、2018年にAcitivityPubを実装し分散型になったことで、より多くの方に認知され利用されるサービスになり、現在に至ります。 -Misskeyという名前は、syuiloが当時聴いていたMay'nというアーティストの楽曲、Brain Diverの歌詞に由来します。 +
ℹ️ Misskeyという名前は、syuiloが当時聴いていたMay'nというアーティストの楽曲、Brain Diverの歌詞に由来します。
誰でも開発に参加することができ、現在でも活発に開発が続いています。 @@ -23,7 +23,7 @@ Misskeyのすべてのソースコードは[AGPL](https://github.com/misskey-dev 上述の分散型を実現するためにも、オープンソースであるということは必要不可欠な要素です。 再び引き合いに出しますが、TwitterやFacebookなどの利益を得ているほとんどのサービスはオープンソースではありません。 -技術的に言うと、MisskeyのソースコードはGitで管理されていて、リポジトリは[GitHub上でホスティングされています。](https://github.com/misskey-dev) +
ℹ️ 技術的に言うと、MisskeyのソースコードはGitで管理されていて、リポジトリはGitHub上でホスティングされています。
## 開発に参加する、プロジェクトを支援する Misskeyを気に入っていただけたら、ぜひプロジェクトを支援してください。プロジェクトに貢献するには、以下で紹介するようにいろいろな方法があります。方法によっては開発のスキルは不要なので、誰でも気軽に参加し貢献することができます。いつでもお待ちしています。 @@ -113,3 +113,4 @@ Misskeyは開発が進むにつれ使用する技術も大きく変わってき ### 時折目にする猫耳の可愛い女の子は？ Misskeyの守り神、藍ちゃんです。ｱｲﾁｬﾝｶﾜｲｲﾔｯﾀｰ! +
ℹ️ 藍ちゃんについてはこちらです。
diff --git a/src/docs/ja-JP/general/troubleshooting.md b/src/docs/ja-JP/general/troubleshooting.md index 8babb3523..6e3db8e46 100644 --- a/src/docs/ja-JP/general/troubleshooting.md +++ b/src/docs/ja-JP/general/troubleshooting.md @@ -1,7 +1,8 @@ # トラブルシューティング +
ℹ️ よくある質問も合わせてお役立てください。
+ 問題が発生したときは、まずこちらをご確認ください。 該当する項目が無い、もしくは手順を試しても効果がない場合は、サーバーの管理者に連絡するか[不具合を報告](./report-issue)してください。 -[よくある質問](./faq)も合わせてお役立てください。 ## クライアントが起動しない ほとんどの場合、お使いのブラウザまたはOSのバージョンが古いことが原因です。