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

Better README #17

Open
11 tasks
omroka opened this issue Mar 29, 2024 · 1 comment
Open
11 tasks

Better README #17

omroka opened this issue Mar 29, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@omroka
Copy link
Owner

omroka commented Mar 29, 2024

The README should be clearer

  • It should specify that Git has to be installed
  • "Implementation Notes" should be completed
  • Step 2 should be broken in 2 steps and directory creation may be easier with the file explorer
  • Step 4 can be broken in 2 steps : 1 optional review of the config file and later 1 about meta.js
  • Explain how to visualize localhost server preview
  • "Features" could be easier to understand
  • "Config" could be clearer : explain first the steps people may want to do first (modify the languages, the appearance...)
  • Maybe a small tutorial on how to write your first page and change the CSS a bit ?
  • "Get help" should link to 11ty Discord server
  • Maybe add how to contribute and how to give feedbacks?
  • Add a reminder to manually change the url from localhost:8080 to localhost:8080/en/ because redirects only work on the server
@omroka omroka added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Mar 29, 2024
@omroka
Copy link
Owner Author

omroka commented Mar 29, 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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant