Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Fix readme pr #1008

Merged
merged 38 commits into from
Apr 12, 2023
Merged

Fix readme pr #1008

merged 38 commits into from
Apr 12, 2023

Conversation

rodrigo-pino
Copy link
Contributor

@rodrigo-pino rodrigo-pino commented Mar 27, 2023

Made separate files for installation and contributions, added discord and Twitter badges

Merged CONTRIBUTING.md and Contributing.md

@rodrigo-pino rodrigo-pino mentioned this pull request Mar 27, 2023
@piwonskp
Copy link
Contributor

Let's also resolve #1007 in that PR

installation.md Outdated Show resolved Hide resolved
installation.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
installation.md Outdated Show resolved Hide resolved
installation.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
installation.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
@rjnrohit
Copy link
Contributor

rjnrohit commented Apr 7, 2023

I'd prefer the restructuring of the readme and the resources in the following manner:

  1. Move contributing.md to this location and update the hyper link at here. Remove contributing.md file from the WARP codebase

  2. Sync dependencies with dependencies.md and delete dependencies.md file from warp codebase.

  3. A quickstart section can be added at this place moving all contents from the readme-quickstart section to there, same thing can be done for Installation section at this location. And, also for Usage section. Warp README may contrain hrefs for these resources

  4. Sync Cli commands with warp cli and get rid of CLI Commands section.

  5. We can create docker category at location https://nethermindeth.github.io/warp/docs/category/docker keeping all docker stuffs related to warp.

In essence, what I want (well.. it's my preference) to keep WARP README as small as possible only containing hyperlinks to the various info and resources and should include only vital infos like unsupported features, logo, warp title, social media badges and handles etc...

Pls react thumbs up if you agree with me or concern your issue with a reply.

@piwonskp
Copy link
Contributor

@rjnrohit I agree with most points, but I suggest posting it in the issue #1014 or #1029. Let's do urgent changes here and talk about long term goals in the issue

rodrigo-pino and others added 2 commits April 10, 2023 08:22
Co-authored-by: Piotr Piwoński <[email protected]>
Co-authored-by: Piotr Piwoński <[email protected]>
contributing.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
contributing.md Outdated Show resolved Hide resolved
rodrigo-pino and others added 2 commits April 12, 2023 09:15
Co-authored-by: Carmen Irene Cabrera Rodríguez <[email protected]>
@JorikSchellekens
Copy link
Contributor

Agree with @rjnrohit's points. Please make sure all of this is captured in the issues.

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.

6 participants