nushell / nushell/nushell.github.io

have two channels for the website

Open
#808 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
258
Forks
561
Avg merge
3h 20m
Merged PRs (30d)
15

Description

as the following PR has been closed

  • #804

i've been thinking about something that could be cool to allow

  • probably the major part to enjoy a stable experience when looking at the website
  • people like me who build nushell from source almost everyday to have access to bleeding edge documentation

❔ could it be possible to have two parallel channels for the website?

  • ⚖️ the default one would build the final HTML pages based on the latest stable tag
  • 🩸 the other one could be toggled on or off and would show up the latest main
implications
  • ⚖️ tag this repo once in a while when the version is bumped up
  • 🩸 people could, after a documentation-changing PR over in the main nushell, apply the changes here with a single nu make_docs.nu and link to the associated nushell PR for completeness

what do you think? 😋 👋

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading make_docs.nu and the context of closed PR #804, then trace how the website currently builds from repository content. Determine what would be required for stable-tag and main channels, including the toggle and tag workflow. Done means both channels build and publish the intended documentation versions reliably.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.