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

Cleanup README #8

Open
simonrjones opened this issue Jul 1, 2022 · 1 comment
Open

Cleanup README #8

simonrjones opened this issue Jul 1, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@simonrjones
Copy link
Member

Would be good for us to clarify the purpose of the README, is it to setup Amplify itself to update it? Or use Amplify in your project, or both?

Feels like it's more useful to link to the Getting Started page for using Amplify in your own project, and move any docs related to this to the Getting Started page.

Do people agree?

If so, we can review the README with this in mind. I'd also recommend removing redundant information from the README, e.g. Syncing tasks.

@simonrjones simonrjones added the documentation Improvements or additions to documentation label Jul 1, 2022
@simonrjones
Copy link
Member Author

I'd recommend the README has an initial section on Using Amplify to build a website where we point people to the getting started page and link to the download ZIP file to grab the Amplify files.

https://github.com/studio24/amplify/releases/latest/download/amplify.zip
https://amplify.studio24.net/amplify/get-started/

The next section can then be on Working on the Amplify project which is really what the rest of the README is about.

Anything else not to do with working on Amplify should be moved to the docs folder or the Amplify docs.

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
None yet
Development

No branches or pull requests

1 participant