Altinn / Altinn/altinn-studio-docs

Documentation for each component

Open
#350 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
15
Forks
59
Avg merge
1d 11h
Merged PRs (30d)
53

Description

### Component documentation
We currently have no structured information about the capabilities of our components in the user docs. We have the technical docs in our json-schema, but more visual and descriptive docs would be useful.

I feel it would be natural to also structure the component guidelines (https://docs.altinn.studio/app/design/guidelines/components/) together with a technical overview of what is possible with the component to enable app developers to take full advantage of the capabilities.

## Tasks
- [ ] Setup docs for each component with a technical documentation how a component can be used
- [ ] Combine (or at least link to) guidelines for how to use them

Ideally, these docs should be placed under `Create apps \ Development \ User Interface ` in a dedicated component section.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing technical information in the json-schema and the component guidelines at docs.altinn.studio/app/design/guidelines/components/. Identify the components and documentation structure under Create apps > Development > User Interface. Done means each component has visual, descriptive, and technical usage documentation, with its guidelines combined or linked.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.