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

Reduced README for Docs-website launch #486

Merged
merged 6 commits into from
Aug 16, 2023
Merged

Conversation

Pabl0cks
Copy link
Collaborator

Description

First version of the SE-2 Website and Documentation Website are ready to launch, so we need to reduce our current README and add links to the Docs on it.

Additional Information

Related Issues

Closes #474

Your ENS/address: pabl0cks.eth

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@technophile-04 technophile-04 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good to me Pablo !!!, I think it is ready to merge but let's get one more opinion too 🙌

@Pabl0cks
Copy link
Collaborator Author

Until we update it should we add https://scaffold-eth-2-docs.vercel.app/ her for now ?
Same here ? https://scaffold-eth-2-docs.vercel.app/ ?

For the links, I was with the mindset of don't have this PR merged until Austin points the prod domain and subdomain to both the website and the docs. If you see it better, I can update to the vercel domain and then update the links to prod whenever they are ready.

This looks really good to me Pablo !!!, I think it is ready to merge but let's get one more opinion too 🙌

Thanks! Sure!

@technophile-04
Copy link
Collaborator

I was with the mindset of don't have this PR merged until Austin points the prod domain and subdomain to both the website and the docs.

Yup yup I agree, I will talk with Austin 🙌

README.md Outdated Show resolved Hide resolved
@damianmarti
Copy link
Collaborator

Thanks @Pabl0cks everything looks great!!

One small comment.

The link to the documentation below the Quickstart section looks a little small there.

Maybe is better to add a Documentation section, and add the link to the documentation and the website there again (I know that these links are at the README start, but maybe the people can miss it there).

Thanks!

@Pabl0cks
Copy link
Collaborator Author

Thanks for the feedback @damianmarti

Agree with you, that sentence with docs link after Quickstart section won't catch the eye from the people that missed the first link.

I've just pushed the change to add Documentation section before Contributing.

Note: If we add the website link to Scaffold-ETH 2 repo in the future, we probably should delete that website mention from the Documentation section.

@technophile-04
Copy link
Collaborator

We have configured the DNS, scaffholdeth.io and docs.scaffoldeth.io point new website and docs

Tysm all, Merging this 🙌

@technophile-04 technophile-04 merged commit 6a2fa15 into main Aug 16, 2023
1 check passed
@technophile-04 technophile-04 deleted the readme-docs-website branch August 16, 2023 14:54
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

Successfully merging this pull request may close these issues.

Update the README when SE-2 Docs website is Live
5 participants