Proposal: Kit, doc-kit's mascot, and a tagline for the site

オープン
#1,197 コメント 3 件 リアクション 3 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
1〜2日
初心者へのやさしさ
38/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
javascript
領域
design

調査の方向性

Start with the branding proposal in this issue and review the mascot, tagline, and color options alongside the linked discussion in #1192. The PR currently uses the proposed assets in www/theme/components/Brand.jsx and www/public/; the issue is done when the branding discussion reaches a decision and the site reflects the agreed direction.

索引モデルが issue の本文から書いたものです。

説明

question / discussion

Hey folks 👋

On #1192 we agreed the branding needs its own discussion, so here's a proposal for it. The PR uses all of this for now, and I'm happy to swap any of it for whatever we land on here.

Kit

A cat called Kit, after doc-kit. It's a flat head, so it works as a mark from a 16px favicon up to the home page's hero, in both color schemes, and it has a couple of poses for the spots where the site can be a bit playful: asleep on the 404 page, and peeking over the home page's last section.

Kit as the mark, the wordmark, the favicon and app icon, asleep on the 404 page, peeking over the home page, on the hero and on the social card

On the PR the drawings live in www/theme/components/Brand.jsx and www/public/.

Tagline

The home page's headline is a placeholder for now, "The docs toolkit for APIs." A few other ideas:

  • The docs toolkit for APIs.
  • API docs from plain Markdown.
  • Write it once, get every format.
  • The toolkit behind the Node.js API docs.

Colors

The site sticks to the neutral greys doc-kit's default theme already uses, no green, so it doesn't read as a Node.js page out of the box.

What do y'all think?

cc @avivkeller

主要言語
JavaScript
スター
70
フォーク
79
平均マージ
1日 21時間
マージ済み PR(30日)
39

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nodejs/doc-kit のほかの issue

nodejs/doc-kit の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。