nushell / nushell/nushell.github.io
a refactoring idea to rewrite the `README`
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 258
- Fork
- 561
- Merge medio
- 3h 20m
- PR unite (30g)
- 15
Descrizione
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 π
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu β evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia da README.md, CONTRIBUTING.md e dalle definizioni dei percorsi in .vuepress/configs/. Esamina come vengono referenziati blog/, book/, commands/, contributor-book/, cookbook/ e le directory delle lingue prima di proporre lo spostamento. Il lavoro Γ¨ completato quando il repository dispone di un README orientato allo sviluppo, il contenuto in inglese si trova sotto en/ e tutti i percorsi documentati rimangono coerenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown
- Ambito
- documentation, internationalization
- Tipo di issue
- Refactoring
- DifficoltΓ
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attivitΓ
- Ferma
- Chiarezza
- Abbastanza chiara
- IdoneitΓ per principianti
- 32/100