Rework repo README - Githubissues

litentry / litentry-parachain

The Litentry parachain

https://docs.litentry.com

GNU General Public License v3.0

62 stars 20 forks source link

Rework repo README #1434

Open Kailai-Wang opened 1 year ago

Kailai-Wang commented 1 year ago

Context

The current repo README has many broken links/badges and outdated information. Shall we revamp and refresh it?

It doesn't need to contain every detail but should include:

the parachain logo and proper links (e.g. gitbook, CI badges)
a general introduction to parachain and tee-worker
how to build and run parachain and tee-worker - in case someone wants to play around it locally
remove outdated information (e.g. extend the leasing period, which is resolved by https://github.com/litentry/litentry-parachain/pull/1431)

:heavy_check_mark: Please set appropriate labels and assignees if applicable.

jingleizhang commented 1 year ago

cc @cryptoade1

github-actions[bot] commented 1 year ago

:exclamation: This issue is stale because it has been open for 60 days with no activity. Remove Stale label or update it, otherwise this issue will be closed in 7 days. @litentry/parachain

Kailai-Wang commented 1 year ago

Still relevant

LisaGadatschX commented 1 year ago

Has this task been completed and reviewed @Kailai-Wang @cryptoade1 ? Can it be closed?

cryptoade1 commented 1 year ago

Almost done.

I submitted the PR already but @grumpygreenguy found an error as a result of the change of the usage and options for the launch script by @felixfaisal.

Once he lists the changes, the final PR will be submitted.

LisaGadatschX commented 1 year ago

I want to follow up on this issue again. Are you still waiting for input on this @cryptoade1 ?

Kailai-Wang commented 1 year ago

Hi @cryptoade1 would you please solve the review comments and maybe update the doc accordingly? If you have any questions you could raise them either in slack or DM that reviewer

cryptoade1 commented 1 year ago

All the comments have been resolved and the changes earlier made weren't merged as I have to clarify the new commands with Faisal as this PR is affecting it. The only thing left is the screenshots to show that it's working (all ready but it isn't uploading, not sure what the issue is, I'll consult Ariel on it). I've committed the changes without it anyways and will update it as soon as I hear from him.

cryptoade1 commented 1 year ago

Update:

The issue is from my end.

Screenshots to show the worker is working updated and final PR submitted @Kailai-Wang