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

Replace Strapi Readme boilerplate with instructions specific to our repo #62

Open
madcalf opened this issue Jun 6, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@madcalf
Copy link
Contributor

madcalf commented Jun 6, 2024

The current Readme contains the Strapi boilerplate documentation and doesn't really document how to set up and develop on our specific repo.

Proposed solution:

  • Add clone and yarn install steps to the beginning, which are the very first things needed to run our API

  • Since we are using yarn as our package manager, remove the npm instructions, which may cause conflicts when mixed with yarn.

  • Add instructions to set up the .env file with the required keys.
    (Note: these instructions are currently included in PR doc: add gitpod setup to the readme #55, but I think they're better located outside of the gitpod section since they apply to local setup as well.)

  • Remove the Deployment section, which is more Strapi boilerplate that doesn't offer any useful information for our project.

  • Remove or rename the Learn more and Community sections. These are also Strapi specific so anyone seeking info about our API might be disappointed to arrive at the Strapi docs and community.

    • If we want to keep these links to Strapi docs, perhaps we rename those sections so it is clear what they're getting. (E.g. Strapi Resources or Learn more about Strapi and Strapi Community.)
@madcalf madcalf added the documentation Improvements or additions to documentation label Jun 6, 2024
@thegrumpyenby thegrumpyenby moved this to Ready for Work in DA Tech Aug 1, 2024
@veryeli veryeli linked a pull request Sep 5, 2024 that will close this issue
@veryeli veryeli removed a link to a pull request Sep 5, 2024
@veryeli veryeli moved this from In Progress to In Review in DA Tech Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

1 participant