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

88 - Update placeholder end-user README #116

Merged
merged 10 commits into from
Dec 24, 2023
Merged

88 - Update placeholder end-user README #116

merged 10 commits into from
Dec 24, 2023

Conversation

Derpius
Copy link
Member

@Derpius Derpius commented Dec 24, 2023

Issue

Resolves #88

Changes

  • Replace the placeholder root README.md with an initial draft of the end-user readme
  • Update release CI to overwrite the Lest package-specific README with the root
    • Package-specific readmes will be used for development instructions

Impact

Significantly improves the new user experience by providing key information and useful links to documentation etc.

Testing

n/a

You can see the readme here: https://github.com/TAServers/lest/tree/88-new-readme

Helpful Links

API Docs

Project Board

Discord

@Derpius Derpius requested a review from a team December 24, 2023 13:17
@Derpius Derpius merged commit bdc45ac into master Dec 24, 2023
13 checks passed
@Derpius Derpius deleted the 88-new-readme branch December 24, 2023 17:26
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.

Write proper readme
2 participants