a refactoring idea to rewrite the `README`
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 32/100
- Type d'issue
- Refactorisation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- markdown
- Domaine
- documentation, internationalization
Piste de recherche
Commencez par README.md, CONTRIBUTING.md et les définitions de chemins dans .vuepress/configs/. Examinez comment blog/, book/, commands/, contributor-book/, cookbook/ et les répertoires de langues sont référencés avant de proposer le déplacement. C'est terminé lorsque le dépôt dispose d'un README orienté développement, que le contenu anglais se trouve sous en/ et que tous les chemins documentés restent cohérents.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
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 😉
- Langage dominant
- TypeScript
- Étoiles
- 261
- Forks
- 561
- Merge moyen
- 3 h 51 min
- PR mergées (30 j)
- 15
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de nushell/nushell.github.io
-
Difficulté 1/5 1-3 heures Accessibilité débutants 68/100
nushell/nushell.github.io#2081 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 62/100
nushell/nushell.github.io#767 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 3/5 1-2 jours Accessibilité débutants 58/100
nushell/nushell.github.io#2232 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 3/5 1-2 jours Accessibilité débutants 58/100
nushell/nushell.github.io#2209 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
nushell/nushell.github.io#2194 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de nushell/nushell.github.io
Issues similaires
-
A hung CI job runs for 6 hours before it is cancelledPeut-être pris @Olanetsoft l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Olanetsoft/agent-lookout#110 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
thedotmack/claude-mem#4757 ·
Les mainteneurs répondent en général sous 1 jour
-
🐛 bug 🗺️ MCP OAuth
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
LibreChat-AI/LibreChat#17077 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 75/100