Skip to content
This repository was archived by the owner on Feb 18, 2025. It is now read-only.

Conversation

@IvanKiral
Copy link
Contributor

Motivation

Update readme to describe how the application works

Checklist

  • Code follows coding conventions held in this repo
  • Automated tests have been added
  • Tests are passing
  • Docs have been updated (if applicable)
  • Temporary settings (e.g. variables used during development and testing) have been reverted to defaults

How to test

If manual testing is required, what are the steps?

@IvanKiral IvanKiral requested a review from a team June 8, 2022 07:07
Copy link
Contributor

@Simply007 Simply007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text is good.

I would adjust the Model Mapping and Data Fetching for a smoother flow.

I would love to have in every section some code sample in pseudo typescript. I have drafted some, so try to apply this.

Copy link
Contributor

@Simply007 Simply007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is already one section about deployment

  • rut lint on readme

IvanKiral and others added 6 commits June 14, 2022 09:21
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
@IvanKiral
Copy link
Contributor Author

I have merged data fetching and content modelling into one section, however it seemed to me better to have only one code block there, as it does not make much sense to showcase how the interface looks like. On the other hand as you said people mostly find the the code and then read the lines above... Should I somehow add some generic interface for type there?

From other changes, I made some paragraphs shorter, as I felt that some information were unnecessary. I removed some links, because I thought that it may annoy people more, when there is a lot of links to other files. Also I run prettier on the file. And lastly I have added code blocks for more paragraphs. For instance for Handling 404 I did not add any, it only explain concept what we did, not what developer can do in the project.

@IvanKiral IvanKiral requested a review from Simply007 June 16, 2022 10:34
Copy link
Contributor

@Simply007 Simply007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For further reference - the best form for readme is to use passive. If you are up for it - you can rewrite the text in this form, but let's keep it optional - for important parts - I have placed the suggestions.

Before sending to another review - run the text using Grammarly.

IvanKiral and others added 10 commits June 21, 2022 11:37
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
@IvanKiral IvanKiral requested a review from Simply007 June 21, 2022 10:35
Copy link
Contributor

@Simply007 Simply007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of nitpicks

README.md Outdated
In Kontent each language is identified by codename, in case of this project, it is `en-US` and `es-ES`.
### Resoure strings
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Resoure strings
### Resource strings

IvanKiral and others added 2 commits June 23, 2022 11:26
Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
@IvanKiral IvanKiral requested a review from Simply007 June 23, 2022 09:36
Copy link
Contributor

@Simply007 Simply007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last thing

Co-authored-by: Ondřej Chrastina <9218736+Simply007@users.noreply.github.com>
@IvanKiral IvanKiral requested a review from Simply007 June 27, 2022 08:21
@Simply007 Simply007 merged commit 4980eec into master Jun 27, 2022
@Simply007 Simply007 deleted the update_readme branch June 27, 2022 08:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants