SAP / SAP/spartacus-docs

DOC: Design Documentation

Open
#67 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
11
Forks
22
Avg merge
7d 3h
Merged PRs (30d)
2

Description

A request has been made for Design Documentation, which would cover the philosophy, functional design, grid framework, etc of Spartacus. This could possibly be a part of a "business analyst" geared introductory overview of Spartacus. To be investigated...

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 with the issue description and review the existing Spartacus documentation to determine whether design material already exists. Clarify the scope and intended audience for the philosophy, functional design, grid framework, and possible business-analyst overview. Done means an agreed structure and complete design documentation covering the selected scope.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
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.