a refactoring idea to rewrite the `README`
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 32/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- markdown
调研方向
从 README.md、CONTRIBUTING.md 以及 .vuepress/configs/ 中的路径定义开始。在提出移动方案之前，检查 blog/、book/、commands/、contributor-book/、cookbook/ 和语言目录的引用方式。完成的标准是：仓库拥有面向开发的 README，英文内容位于 en/ 下，并且所有文档中记录的路径保持一致。
由索引模型根据 Issue 内容生成。
描述
hello there 👋 😋
i feel this website repository is mainly made for developers or people who click on the "Edit this page on GitHub" button in the footer.
the other day i was looking for contribution guidelines and ended up asking how to run the website locally on the discord...
i did not see the CONTRIBUTING.md file in the root of the repo 😭
in fact, i looked at the main README, looking for instructions but found none => this is because the main ./README.md file IS the
english frontpage of www.nushell.sh!
my idea
i propose to move the frontpage of the website to some other place than ./README.md and write a true development-oriented README.md
to:
- point to the website itself at www.nushell.sh
- point to the main
nushellrepo - explain in details how to contribute to this repo OR at least explicitely point to
CONTRIBUTING.md
some details
- i think the paths to all the pages
MDfiles are specified in.vuepress/configs/, right? - i propose to move
blog/,book/,commands/,contributor-book/andcookbook/to a newen/directory, leading to the following architecture:
.
├── CNAME
├── CONTRIBUTING.md
├── i18n-meta.json
├── i18n.nu
├── LICENSE
├── make_docs.nu
├── package.json
├── package-lock.json
├── README.md
├── assets/
├── de/
├── es/
├── en/
├── ja/
├── pt-BR/
├── snippets/
├── tr/
└── zh-CN/
and one more level details
.
├── CNAME
├── CONTRIBUTING.md
├── i18n-meta.json
├── i18n.nu
├── LICENSE
├── make_docs.nu
├── package.json
├── package-lock.json
├── README.md
├── assets
│ └── images
├── de
│ ├── README.md
│ └── book
├── es
│ ├── README.md
│ ├── book
│ └── contributor-book
├── en
│ ├── blog
│ ├── book
│ ├── commands
│ ├── contributor-book
│ └── cookbook
├── ja
│ ├── README.md
│ └── book
├── pt-BR
│ ├── README.md
│ ├── book
│ └── contributor-book
├── snippets
│ ├── installation
│ ├── introduction
│ └── moving_around
├── tr
│ ├── README.md
│ └── book
└── zh-CN
├── README.md
└── book
that way
- the english default channel would be just another language channel, even though the prefered one by default
- the repo would have a more homogenous structure
- we would be able to move the english frontpage from
README.mdtoen/README.md, as with the other languages - we would be able to write a true
READMEfor the website repo
i wanted to have some feedback before trying to refactor the website like this.
shouldn't be that much work, mainly changing paths, but ehe 😉
- 主要语言
- TypeScript
- 星标
- 260
- 派生
- 563
- 平均合并
- 4 小时 36 分钟
- 30 天内合并 PR
- 16
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nushell/nushell.github.io 的其他 Issue
-
难度 1/5 1-3 小时 新手友好度 68/100
nushell/nushell.github.io#2081 · 3 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 62/100
nushell/nushell.github.io#767 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 58/100
nushell/nushell.github.io#2232 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 58/100
nushell/nushell.github.io#2209 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 45/100
nushell/nushell.github.io#2194 ·
维护者通常 1 天内回复
查看 nushell/nushell.github.io 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 4 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复