ni / ni/nimble

Create a "Getting Started" walkthrough for Nimble Angular

Open
#726 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
39
Forks
14
Avg merge
1d 16h
Merged PRs (30d)
13

Description

😯 Problem to Solve

A getting started guide to creating an angular app with nimble components would help be get up and running.

💁 Proposed Solution

Create a tutorial for a simple angular/nimble app.
Will need a documentation website to put the content on (might could be done with existing Storybook...not sure).

Examples:

IBM (Carbon Design System):
https://carbondesignsystem.com/developing/react-tutorial/overview/
https://react-spectrum.adobe.com/react-spectrum/getting-started.html#setting-up-your-app
https://www.lightningdesignsystem.com/platforms/heroku/

Considerations

The tutorial should address some initial, common, getting started tasks. Some aspects that would be very helpful:

  • Expect that the user is starting from nothing...except that maybe they have Angular installed.
  • Having a simple end goal such as a To Do, Tic Tac Toe, basic panels, etc. Something slightly more advanced than Hello World, but not much.
  • If there are specific Angular versions, help the user use the correct version.
  • Make it compelling. A README will functionally do the job. A richer experience and design will be more engaging and demonstrate our passion for experience, design and quality.
  • At a minimum, the user should be able to get typography and some basic components used for the demonstration. Theming would be beneficial but not required for an initial Getting Started unless we intend to walk them through creating a UI and business logic to modify the theme (perhaps a good idea for a Part II of Getting Started)
  • If there are any other environment pieces to install/configure (like linting) provide those instructions.
  • Provide a feedback mechanism so users of this tutorial can ask questions, submit issues, etc.

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

No files, tests, or documentation entry points are named. Start by locating the existing documentation or Storybook site and the Angular/Nimble setup instructions, then define the tutorial's simple app and supported Angular version. Done means a published walkthrough covers setup, typography, basic components, relevant configuration, and a feedback mechanism.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
documentation, frontend
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.