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

Harmonize README locations #116

Open
3 tasks
haerdib opened this issue Apr 29, 2022 · 2 comments
Open
3 tasks

Harmonize README locations #116

haerdib opened this issue Apr 29, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@haerdib
Copy link
Contributor

haerdib commented Apr 29, 2022

We currently have several README and Tutorial locations. There are local Repo READMEs (Integritee & encointer), the Integritee (& SCS) Wiki and the Book. Several duplications are there and not everything is kept up to date.

We should do the following:

  • Decide which information should be documented where. Inform the Team about the decision.
  • Remove redundant information, and maybe place the link to the information instead.
  • Update outdated information

Example:

@haerdib haerdib added the documentation Improvements or additions to documentation label Jun 8, 2022
@haerdib
Copy link
Contributor Author

haerdib commented Aug 29, 2022

Goal: Detailed Docu in the gitbook. The README in the repos should link to the gitbook and be very minimal (E.g. no double maintenance of READMEs)

@haerdib
Copy link
Contributor Author

haerdib commented Sep 12, 2022

in all Repos & all readmes

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
Projects
None yet
Development

No branches or pull requests

1 participant