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 Docs #76

Open
6 of 14 tasks
IkeHunter opened this issue Sep 11, 2024 · 0 comments
Open
6 of 14 tasks

Update Docs #76

IkeHunter opened this issue Sep 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@IkeHunter
Copy link
Collaborator

IkeHunter commented Sep 11, 2024

Stuff to update

Design System

  • Explanation of design system
  • How to use type system
  • How to use color system
  • How to use SCSS mixins for type/colors
  • Using the gridding system

System & Config

  • How to connect to spotify SDK
  • How to run network docker-compose file
  • How to setup Spotify app, get access token
  • How to use network api docs

Interfaces, Types, Contracts

  • Explain .d.ts files, and their role (many sources online have differing opinions)
  • Explain how Typescript interfaces act as contracts between the front and backend
  • Explain naming convention for interfaces, and prepending 'I' (like IUser)

Misc

@IkeHunter IkeHunter added the documentation Improvements or additions to documentation label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant