Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Github readme for developers #2350

Open
mrosvik opened this issue Aug 29, 2024 · 1 comment · May be fixed by #3315
Open

Update Github readme for developers #2350

mrosvik opened this issue Aug 29, 2024 · 1 comment · May be fixed by #3315
Assignees

Comments

@mrosvik
Copy link
Member

mrosvik commented Aug 29, 2024

No description provided.

@mrosvik mrosvik added this to the V1 - Helhetlig dokumentasjon milestone Aug 29, 2024
@mrosvik mrosvik changed the title Artikkel: Kom i gang som utvikler Update readme for developers Jan 20, 2025
@mrosvik mrosvik changed the title Update readme for developers Update Github readme for developers Jan 20, 2025
@mrosvik mrosvik removed this from the V1 - Must-have milestone Jan 20, 2025
@Barsnes
Copy link
Member

Barsnes commented Jan 23, 2025

I think it would be nice to keep the readme as low-level as possible. However, this is hard since we don't yet have a developer specific documentation where we can go deeper on a subject if we need to.

Easy to read sentences, and a natural flow between sections.

I suggest the root readme tells the consumer about the different packages, how they can use them - but no in-depth implementation documentation. We can do a drill-down inside of the package readmes, but we need to make sure we clearly link to them from the root readme.

@mimarz mimarz moved this from 📄 Todo to 🏗 In progress in Team Designsystemet Mar 5, 2025
@mimarz mimarz linked a pull request Mar 5, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🏗 In progress
Development

Successfully merging a pull request may close this issue.

3 participants