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

Additional changes to README #114

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Additional changes to README #114

wants to merge 4 commits into from

Conversation

OlaPom
Copy link
Contributor

@OlaPom OlaPom commented Jul 13, 2023

Hello again!
This PR is for some additional changes I would like to suggest to your file. They are loosely inspired by technical writing style guides(such as Google Developer Style Guide or Microsoft Style Guide).

  1. “Functionalities” - I focused on the language and rephrased some sentences that seemed too complicated (to me).
  2. “Deployment” - this part is a real fun with all these different task descriptions :)
    I suppose that the file will change as your website develops, so I don’t want to suggest any revolution in the structure. However, I think that these writing tips would help keep it organised:
  1. “Repository structure” - it says that it’s a list of the main files and folders. Does it mean you want to have only the most important files listed here or all of them? I can update the list with the names of the missing files, but you would have to add the descriptions.
  2. Screenshots - if the interface changes frequently, then there is no point in adding screenshots, but I think it might be a good idea for the future.

Issue #106

@OlaPom OlaPom changed the title Additional changes to README issue #106 Additional changes to README Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

Successfully merging this pull request may close these issues.

1 participant