Orange-OpenSource / Orange-OpenSource/Orange-Boosted-Bootstrap

Refactor our getting-started pages

Open
#3,402 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

📖 documentation 🗳️ feature
Dominant language
CSS
Stars
219
Forks
61
Avg merge
2d 15h
Merged PRs (30d)
12

Description

Prerequisites
Proposal

Refactor most of our getting-started pages to better convey the npm way.

To achieve it, we should probably:

  • Drop links and ways to download the package as stated in #3382/
  • Better our landing page
  • Better the documentation and maybe introduce a page to summarize and replace many of the pages we have to expose the different way we encourage.
Motivation and context

Following #3382.

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 reviewing the existing getting-started pages and the context in #3382. Map the current download guidance, landing page, and documentation pages before deciding what can be consolidated. Done means the pages clearly present the npm workflow and replace or remove the outdated package-download paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, javascript, sass
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.