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

The README should link to the golemverse website #1026

Closed
1 task done
ColinFay opened this issue Apr 4, 2023 · 1 comment
Closed
1 task done

The README should link to the golemverse website #1026

ColinFay opened this issue Apr 4, 2023 · 1 comment

Comments

@ColinFay
Copy link
Member

ColinFay commented Apr 4, 2023

Validation

  • The README links to the golemverse website instead of listing the resources
@ilyaZar ilyaZar mentioned this issue Jul 5, 2023
VincentGuyader added a commit that referenced this issue Aug 8, 2023
VincentGuyader added a commit that referenced this issue Aug 8, 2023
* Fix 1026 (#1064)

* docs: link to golemverse for external resources

The "Example Apps" section on the golemverse page is missing, so I kept it there for as a level two header (in case one wants to copy it to the golemvsere page).

* docs: move sections with relevant content for the user to the top

I. user preferences in terms of priority (more or less ...) probably
   1. Installation
   2. New project creation
   3. Every day workflow
   4. Additional resources
   5. Meta info such as about (golem version/code coverage), CoC, how to contribute etc.

II. developer preference in terms of priority (more or less ...) probably
   1. Meta info in the "About" section golem version/code coverage
   2. the rest from above

Though I'd prefer the current ordering myself it might be a wise choice to change it towards the user, but that's a matter of taste.

Fix some typos and markdown styling.

---------

Co-authored-by: vincent guyader <[email protected]>

* chore update README

fix #1026

---------

Co-authored-by: Ilya Zarubin <[email protected]>
@ColinFay ColinFay changed the title The vignette should link to the golemverse website The README should link to the golemverse website Oct 13, 2023
@ColinFay
Copy link
Member Author

This has been included in the dev README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant