nushell / nushell/nushell.github.io
a refactoring idea to rewrite the `README`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
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 π
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up β it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.md, CONTRIBUTING.md, and the path definitions in .vuepress/configs/. Review how blog/, book/, commands/, contributor-book/, cookbook/, and the language directories are referenced before proposing the move. Done means the repository has a development-oriented README, the English content is under en/, and all documented paths remain consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, internationalization
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100