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.

Sign up for GitHub

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

Jump to bottom

Update readme with current build and release instructions #29

Open
2 tasks done
st3phhays opened this issue Sep 30, 2024 · 0 comments
Open
2 tasks done

Update readme with current build and release instructions #29

st3phhays opened this issue Sep 30, 2024 · 0 comments
Labels
0 - Backlog Where tickets start after being triaged. This means the ticket has targeted milestone/labels. Enhancement Enhancements are things that are improvements or features.

Comments

@st3phhays
Copy link
Member

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

The readme in this repository is confusing and hasn't been changed since the repo was forked. It doesn't give a good resource on how to build the repository.

Describe The Solution. Why is it needed?

The readme needs overhauled. Current build instructions are mostly here: https://support.zendesk.com/hc/en-us/articles/4408822095642-Previewing-theme-changes-locally

Then, with the addition of choco-theme, it is to note that yarn and yarn choco-theme is to be ran before the above instructions.

Additional Context

No response

Related Issues

No response
@st3phhays st3phhays added Enhancement Enhancements are things that are improvements or features. 0 - Backlog Where tickets start after being triaged. This means the ticket has targeted milestone/labels. labels Sep 30, 2024
@st3phhays st3phhays changed the title Update readme with current build instructions Update readme with current build and release instructions Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
0 - Backlog Where tickets start after being triaged. This means the ticket has targeted milestone/labels. Enhancement Enhancements are things that are improvements or features.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@st3phhays