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

housekeeping: Improve docs and make help #228

Merged
merged 5 commits into from
Dec 17, 2023
Merged

housekeeping: Improve docs and make help #228

merged 5 commits into from
Dec 17, 2023

Conversation

juliaogris
Copy link
Member

@juliaogris juliaogris commented Dec 14, 2023

  • Document release process.
  • Make first README.md link point to evy.dev rather than scratch.
  • Replace sponsorship red heart emoji with a white one for readability.

Update make help awk scripts for multi-line comments on top or rather than
next to target.

Add /version endpoint to deployment.


Fixes evylang/todo#2
Fixes evylang/todo#3
Fixes evylang/todo#5
Fixes evylang/todo#7
Fixes evylang/todo#8

@juliaogris juliaogris added this to the 🚸 Learn v0.2.0 milestone Dec 14, 2023
Copy link

github-actions bot commented Dec 14, 2023

firebase-deployment: https://evy-lang--228-4m6p9b1r.web.app (0b18c9c)

@juliaogris juliaogris force-pushed the housekeeping branch 2 times, most recently from 4dee724 to 8fde1d1 Compare December 14, 2023 05:33
@camh- camh- self-requested a review December 16, 2023 05:31
Copy link
Member

@camh- camh- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🍏 with a couple of minor comments

Makefile Outdated Show resolved Hide resolved
docs/development/releasing.md Outdated Show resolved Hide resolved
Update `make help` scripting so that target comments are listed above the
target, rather than to the right of it. This makes it possible to write
longer comments and make them easier to read in the Makefile source code.
This update has been taken Camh's offscreen project.

Link: https://github.com/foxygoat/offscreen/blob/12db5ebcf5da8d4cf1fc66f82965b849cf86e90f/Makefile#L108
Issue: evylang/todo#2
Replace sponsorship heart emoji as it shows up read at least on Chrome/Android
is nearly invisible on the red pink background.

Issue: evylang/todo#3
Make first README.md link point to evy.dev rather than scratch. We want to
encourage people to play with Evy with the first clickable link, not read up
on scratch.

Issue: evylang/todo#5
Add releasing documentation, describing the releasing process and the meaning
of minor and patch versions in Evy.

Issue: evylang/todo#8
Add version endpoint to frontend so that it can always be determined which
version of evy is currently in use via https://eyv.dev/version

Issue: evylang/todo#7
Copy link
Member

@camh- camh- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍏

@juliaogris juliaogris merged commit 87f2fa5 into main Dec 17, 2023
3 checks passed
@juliaogris juliaogris deleted the housekeeping branch December 17, 2023 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants