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

Technical Documentation and Separation. #233

Open
mohammedpatla opened this issue Mar 5, 2021 · 8 comments
Open

Technical Documentation and Separation. #233

mohammedpatla opened this issue Mar 5, 2021 · 8 comments
Assignees
Labels
dev / code Issue related to the functioning of the site. Example: Link broken documentation Improvements or additions to documentation Version 1.2

Comments

@mohammedpatla
Copy link
Collaborator

  • Making the domain build.scrt.netwrok => docs.scrt.network
  • Get rid of learn.scrt.netwrok and technical documentation should live on build.scrt.network or on the Website.
  • Making the documentation page link easily accessible from the navbar on the website and from the documentation page.
@CarterLWoetzel CarterLWoetzel added dev / code Issue related to the functioning of the site. Example: Link broken documentation Improvements or additions to documentation Version 1.2 labels Mar 5, 2021
@mohammedpatla
Copy link
Collaborator Author

Picking this up.

Will check if the build site can have any styling similar to the website?
Will create links to the build site from the documentation page and the navbar.

Also @CarterLWoetzel can we have tor open up docs.scrt.network? I would like to point it to the right location.

@CarterLWoetzel
Copy link
Collaborator

@mohammedpatla I will CC him in on this and get the open. Let's have a discussion about this on the web dev call.

@cankisagun
Copy link

I am all in favor of killing learn.scrt and have build.scrt.network point to docs.scrt.network. Going forward we use docs.scrt.network.

Though we should not aspire to have the same website styling for the docs site. I don't think it's necessary and common practice. Our goal should be to have a thorough docs site like NEAR -> https://docs.near.org/docs/develop/basics/getting-started

@mohammedpatla
Copy link
Collaborator Author

Makes sense, first thing I will look at is merging some of the abstract content we have on learn with the build page. Then we can point the build page to the docs subdomain.

I agree with @cankisagun that we should have the documentation website separate altogether. Even though we stay away from the website's main styling, I still think we should have a better-revised styling for our current documentation website, particularly the landing page.
Inspiration from: http://docs.cosmos.network/

@cankisagun
Copy link

I like the cosmos styling, however NEAR (from content perspective) is a better example as cosmos is not a smart contracting platform like us but near is

@mohammedpatla
Copy link
Collaborator Author

@mohammedpatla
Copy link
Collaborator Author

mohammedpatla commented Mar 22, 2021

The Content lives on https://github.com/mohammedpatla/SecretNetwork
Before we create PR people can review it here.

@cankisagun
Copy link

cankisagun commented Mar 22, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev / code Issue related to the functioning of the site. Example: Link broken documentation Improvements or additions to documentation Version 1.2
Projects
None yet
Development

No branches or pull requests

4 participants