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

docs: a nicer readme #155

Merged
merged 1 commit into from
Jan 8, 2025
Merged

docs: a nicer readme #155

merged 1 commit into from
Jan 8, 2025

Conversation

borgoat
Copy link
Member

@borgoat borgoat commented Jan 8, 2025

Summary

I made the readme more approachable, and started splitting more "internal docs"
like that about releasing.

Impact

  • App
  • Supabase functions
  • Supabase migration
  • CI / GitHub
  • pubspec.yaml

Open points

I'd like to improve the dev docs next, adding some stuff about the internal design, the schema, the codebase structure... for now, I just split it to keep the readme lean

@inpt333
Copy link
Collaborator

inpt333 commented Jan 8, 2025

Nice! Just found one small thing, for some reason in the preview with wide screen the mobile image is misaligned. I thought the idea was to have it aligned left, but it's not like that either:

image

In any case, it's possible that it's not reproducible in GitHub since the allocated space for the README is not wide enough.

@borgoat
Copy link
Member Author

borgoat commented Jan 8, 2025

The plan was indeed to have it left aligned with some text to the right (similar to www.grup.rsvp) but I couldn't get it to work. I believe because of the picture tag... no idea why it's not always centred either though..,

@inpt333 inpt333 added this pull request to the merge queue Jan 8, 2025
Merged via the queue into main with commit 03e6abf Jan 8, 2025
1 check passed
@inpt333 inpt333 deleted the docs/readme branch January 8, 2025 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants