stacks-network org README

[wileyj]

re-opening this for comment/review from reverted #3 .

This will be the display page for the stacks-network github org page, with links directing people to resources relevant to what we do.

This commit is a copy/paste from a skiff doc; it still needs a bit of formatting and updates (images etc).
This PR is to start the process and get some discussion going on what it should look like when it is merged.

comments/suggestion for changes are welcome here, or you can PR any changes to the chore/add-readme branch

@muneeb-ali tagging you since you mentioned this in a call

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ wileyj
❌ Will Corcoran

---

Will Corcoran seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[wileyj]

https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile

the folder structure needs to change to match what is here. i.e. put the files that need to be displayed at the org level under the ./profile folder

[wileyj]

for the org readmes, i would organize them a little better in a folder under the ./profile directory with the README.md file being the sole file in that directory. ex:

./profile/README.md
./profile/docs
./profile/images

etc

[wileyj]

I'm also not entirely sold on the idea of having all of the documentation in this repo. would it make more sense to have only the README, and move supporting docs to another repo, like https://github.com/stacks-network/stacks ?

[wileyj]

@marthaadrienne i'm going to move the documents you've commented on to the https://github.com/stacks-network/stacks repo with your suggestions in mind.

they've been removed from this PR, but would appreciate you taking a second look at https://github.com/stacks-network/.github/blob/chore/add-readme/profile/README.md for the choices i made there

@will-at-stacks thoughts on teh formatting changes to the readme?

[marthaadrienne]

Reviewed with no changes. Thank you.

[will-corcoran]

Hey @wileyj just making my way through these comments. All of the suggested format revisions look good to me. Thanks!

@marthaadrienne i'm going to move the documents you've commented on to the https://github.com/stacks-network/stacks repo with your suggestions in mind.

they've been removed from this PR, but would appreciate you taking a second look at https://github.com/stacks-network/.github/blob/chore/add-readme/profile/README.md for the choices i made there

@will-at-stacks thoughts on teh formatting changes to the readme?

[will-corcoran]

@wileyj It looks like the primary Stacks Core Eng is now linking to a Skiff. Is that correct? Goal is to get this information all on GH.

[wileyj]

@wileyj It looks like the primary Stacks Core Eng is now linking to a Skiff. Is that correct? Goal is to get this information all on GH.

what should it be changed to?

[will-corcoran]

it should be pointing to stacks-core-eng-home.md

[wileyj]

i see. that file is part of another, much larger PR that is in draft status stacks-network/stacks#485

would it make sense to remove that link from the readme until it's ready? i would estimate that PR won't be ready for review for at least another day.

[kenrogers]

This is looking good to me, structure makes sense, just some minor suggestions on some formatting and grammatical mistakes.

[will-corcoran]

@wileyj thanks for your work on this! question, is it still going to be held up by me being flagged as not having signed the CLA? The error message is below... it looks like I was not signed into the correct email address via terminal when I pushed this commit. I've since logged in and signed the CLA - but the error does not want to clear... any thoughts?

Will Corcoran seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

[wileyj]

@wileyj thanks for your work on this! question, is it still going to be held up by me being flagged as not having signed the CLA? The error message is below... it looks like I was not signed into the correct email address via terminal when I pushed this commit. I've since logged in and signed the CLA - but the error does not want to clear... any thoughts?

Will Corcoran seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

outside of the question i posed in #5 (comment), the CLA won't be an issue for this PR

[wileyj]

now that stacks-network/stacks#485 is merged, merging this one