f1-dash icon indicating copy to clipboard operation
f1-dash copied to clipboard

docs: improve .md documentation

Open Constrat opened this issue 7 months ago • 2 comments

Resolved grammatical and logical errors.

Standardized a bit more of the markdown styles

Constrat avatar May 25 '25 09:05 Constrat

@Constrat is attempting to deploy a commit to the f1-dash Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 25 '25 09:05 vercel[bot]

~~Sorry about this. I didn't notice the default branch was main.~~ ~~All projects I work with default to the dev branch.~~

Discussion on discord.

TL;DR from discord: develop seems stale and 6 commits behind compared to main. Should I just change the CONTRIBUTING to say "use main" (and merge this in main directly?).

These are all markdown files anyway so even if they go live without passing through a development environment nothing really would change for the frontend / backend

Constrat avatar May 25 '25 09:05 Constrat

For actual new features or PRs that touch code or configs I would like PRs into develop as thats what's deployed to dev.f1-dash.com atm and is there for testing. Not 100% happy with it yet but thats how it is atm. Markdown im fine with direct main PRs

slowlydev avatar May 26 '25 21:05 slowlydev

Perfect. WIll follow this from now on since I've noticed some typos in the frontend as well. I'll be looking at it in the following days.

Constrat avatar May 26 '25 21:05 Constrat