docs: link readme to official docs

[nattb8]

Link the README to the official docs. This way, updating both places won't be necessary. This applies only to identical documentation.

[suluvai]

@nattb8 all for avoiding the work duplication, how would the work flow look like after this change to make new feature releases?

[nattb8]

@nattb8 all for avoiding the work duplication, how would the work flow look like after this change to make new feature releases?

You just need to update the public docs (imx-docs) since it's linked. Currently, you already have to copy the exact information into the README and the public docs.

Note that this doesn't apply to sections like Plugin Maintainers' Guide, as we don't add that to the public docs.

Does that answer your question? Or did I misunderstand your question? What is your concern?

[suluvai]

@nattb8 you did answer the question.

The only concern I might raise is, the documentation process is decoupled with the actual changes now. May lead to getting missed out or left behind with actual changes.

[nattb8]

I don't see how having the documentation in the README would prevent people from forgetting to update it. There is no automation that checks whether the README and public docs are both updated when you release new features. Currently, we just rely on the DoD of the ticket to update it. Could you please explain how having the documentation in the README would prevent people from missing it?

…

On Thu, 9 Nov 2023, 12:15 pm Praveen Suluvai, ***@***.***> wrote: @nattb8 <https://github.com/nattb8> you did answer the question. The only concern I might raise is, the documentation process is decoupled with the actual changes now. May lead to getting missed out or left behind with actual changes. — Reply to this email directly, view it on GitHub <#39 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEAJRHDTMOMLONWB6GTNEW3YDQHAVAVCNFSM6AAAAAA7DUPKAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBSHA3TKMRRG4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[suluvai]

I don't see how having the documentation in the README would prevent people from forgetting to update it. There is no automation that checks whether the README and public docs are both updated when you release new features. Currently, we just rely on the DoD of the ticket to update it. Could you please explain how having the documentation in the README would prevent people from missing it?
…

When it is part of the same PR along with the changes it gets picked up by reviewers.

I am not against this, just voiced my view. If everyone is happy with this approach, happy to go along.

[carleeto]

In the Getting Started section, there's a link to the User Guide section (which has been renamed to Documentation), which needs to be updated.

https://github.com/immutable/unreal-immutable-sdk/blob/docs/clean-up-readme/README.md?plain=1#L32