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

Eine klare und leicht verständliche Dokumentation sollte Teil des Boilerplates sein. #58

Open
Tracked by #46
samuelecalamita opened this issue Mar 4, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@samuelecalamita
Copy link
Collaborator

samuelecalamita commented Mar 4, 2024

Die Dokumentation sollte Schritt-für-Schritt-Anleitungen enthalten, wie die Entwickler das Boilerplate verwenden können, einschließlich der Konfiguration von Tools wie WebComponents, TypeScript, ESLint und Stylelint.

  • npm versions
  • Table of content: und hier vielleicht auch links zu documentatition für die utils, main.ts und andere Sachen (am besten die readme unter den folders utils oder services mit node aus dem js oder ts docs generiert werden)
  • wie nvm verwenden
  • unterschiede zwischen blocks und compoenents
  • scss/css
  • js/ts
  • was machen wir anders als adobe (main.ts genau Dokumentiteren) hier auch beschreiben wie man das layout baut
  • icons Verwendung
  • fonts
  • sidekicklibrary

FAQ Common mistakes oder so

  • mein json wird nicht gefetched?
  • query index was kan da schief gehen
  • hier auch die fragen die wir in confluence beantwortet haben schreiben
@samuelecalamita samuelecalamita added the enhancement New feature or request label Mar 4, 2024
@samuelecalamita samuelecalamita moved this to Ready in EDS-Editorial Mar 4, 2024
@LoomingEcho LoomingEcho moved this from Ready to In progress in EDS-Editorial Mar 18, 2024
@eKrausedivae eKrausedivae moved this from In progress to In review in EDS-Editorial Apr 15, 2024
@samuelecalamita samuelecalamita moved this from In review to In progress in EDS-Editorial Apr 15, 2024
@eKrausedivae eKrausedivae moved this from In progress to In review in EDS-Editorial Apr 17, 2024
@LoomingEcho LoomingEcho moved this from In review to Done in EDS-Editorial May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

When branches are created from issues, their pull requests are automatically linked.

3 participants