Code Monkey home page Code Monkey logo

stratumprotocol.org's Introduction

stratumprotocol.org

Build the project Locally

In order to build the website locally, you'll need Node.js >= 14.16 (or basically the latest LTS version).

The setup is straight forward:

# Install dependencies
yarn install

# Serve locally (by default on port 8080)
yarn dev

Embedding YouTube videos

To add a YouTube video with a preview, you can so so by linking to it like this:

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/mqdefault.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

Note that the link item need to be a preview image (either from YouTube or a custom one) to result in an embedded video.

stratumprotocol.org's People

Contributors

0xsaksham avatar abhijay007 avatar aniket2405 avatar dennisreimann avatar gbks avatar gitgab19 avatar joshr4 avatar kodylow avatar pavlenex avatar plebhash avatar satsie avatar secondl1ght avatar xyephy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

stratumprotocol.org's Issues

[Footer] Weird obstacle in footer

I already reported this, managed to replicate it on two separate Mac devices. There's a weird responsiveness problem with the icons.

Let me know if I can provide any more info. Replicated both locally and via netlify, def not a cache issue.

Screenshot 2022-08-20 at 16 37 15

Check mobile responsiveness (spacing) on each section.

We have some sections where the text almost touches the screen, and some spacing between logos is huge. Is it possible to add more padding to each section (left and right) and keep it consistent throughout the page?

Example:
CleanShot 0004-09-08 at 22 24 04@2x

CleanShot 0004-09-08 at 22 25 52@2x

Pull specs from the specification repo and present them on the website

Maintaining a separate specs text could pontentially mean that in the future we can go out of sync with the specs repository.
I'd like to propose that we pull specs directly from specs repo so that any changes merged there is automatically deployed on our website.

@SeraBocca let me know if this makes sense, if you're not sure on the approach, I can dig a bit to see what we did with BTCPay.

https://github.com/stratum-mining/sv2-spec

Adjust icon sizes

Our current live site icons are 2.5rem (40px) and in the design they are 24px (1.5rem). Can we downsize them to this?
The outer box will then be 48px (0.75 rem padding)

CleanShot 0004-09-08 at 22 11 14@2x

Add `What is Stratum v2` section

Once #17 is removed, we need to add another section to explain SV2.

Text:
Stratum V2 is the next generation protocol for pooled mining. It focuses on making data transfers more efficient, reducing physical infrastructure requirements for mining operations, and increasing security. Additionally, Stratum V2 introduces three new sub-protocols that allow miners to select their own transaction sets through a negotiation process with pools, improving decentralization.

How it looks now

Screenshot 2022-08-31 at 23 19 47

How it should look

Screenshot 2022-08-31 at 23 10 06

Link to figma https://www.figma.com/file/H42PrGnniKFtbfqHYBGevj/Stratum?node-id=147%3A549

This issue can be tackled together with #19

Adjust doc navbar height on desktop scroll

I like the idea of a fixed header on scroll, but can we adjust it's height to be smaller? Right now it feels like it takes up a lot of room. For reference, we can look at the GitHub's navbar height.

CleanShot 0004-09-12 at 08 51 30@2x

CleanShot 0004-09-12 at 08 48 57@2x

Create 404 page

We might want to add a custom 404 page that matches the design?

Update hero image

The current image is too large and does not blend well into the body.

I've exported another, it's smaller and has a better fade-in. Can we see how it looks?
hero-bg

Adjust spacing between titles and text

Spacing between H2 titles and the text below them should be 1.5rem (but you have to take into the account the line height and or default padding on your titles). The total sum of space should be 1.5rem.

Live:
CleanShot 0004-09-08 at 22 19 41@2x

What it should be (screenshot a bit zoomed so it's actually smaller than it looks):
CleanShot 0004-09-08 at 22 21 52@2x

Add Visual of SV2 complete implementation

Vic on BitcoinDesign Slack, that can be reached out in in #stratum channel is designing a visual of a complete SV2 implementation, reach out to him on progress and latest design. You can verify the design with Gene in the same channel since he's leading on design, once you get an visual from them add it.

This is the image Vic is working on improving

  • Vic and Gene need to agree on style, color and make sure it matches our design guidelines
  • Contact Vic in #stratum channel on BitcoinDesign Slack for update on visual
  • When visual is ready add it to the adequate section as shown on Figma or in the image below.

Add who supports SV2

Until we get a confirmation from a few entities what you see on figma in this seciton is just a mockup and shouldnt' be implemeted until @moneyball confirms which entities are okay to go in there, reach out to him on BitcoinDesign Slack/SV2 Discord for confirmation.

Once you get confirmation from @moneyball reach out to Gene to make sure that area is ironed out, if so implement it ๐Ÿš€

Screenshot 2022-08-31 at 23 34 16

Resize logos and add colored logos

I know logo resize back and forth can be frustrating, but we should ensure enough credits is given to the entities that support us without them being the central figure of the entire website. Currently, the logos are way bigger than the content around them and are more prominent than roadmap for example. It's even bigger than the subtitle of that section which doesn't really look sensible imo.

  • Make all logos on the website their default colour, not white.
  • Resize the logos
    • Make the Current Supporters of Stratum V2 smaller
    • Make Who feels SV2 is the right direction a bit smaller than the Supporters of Stratum V2

What we currently have

Screenshot 2022-09-07 at 1 40 39 AM
Screenshot 2022-09-07 at 1 40 48 AM

Add `Roadmap section`

Add roadmap section, currently blocked by waiting for Gene for design and Pavlenex for copy.

Docs section style updates

I just noticed a few small details we could fix on the documentation section (didn't have time to fix so I am posting here):

  • Left nav the padding on the top should match the botttom (the bottom has padding but the top doesn't)
    Top

    image
    Bottom
    image

  • Nav menu on medium screens is broken - needs to be solid background
    image

  • Same padding issue here (below 'Specifications' and before the break line there should be the same padding that is on the top
    image

  • Can the bottom of the left nav line up with the bottom of the docs when you scroll to the bottom?
    image

favicon is inconsistent with the logo

Seems we're using a thicker verison of a logo for the favicon, even though it's a nit ,we probably want to use the same as the one for the logo for consistency.

Screenshot 2022-09-09 at 19 20 42

Investigate font weight on titles in Safari

There seems to be an issue with font weight not being applied in Safari. I inspected a bit and see that it's set to font weight 700, but Safari seems to have an issue with it ๐Ÿค” See screenshot from my browser for reference:

CleanShot 0004-09-08 at 22 17 45@2x

CleanShot 0004-09-08 at 22 19 05@2x

Adjust headline size

Let's set the font size of "one giant leap for bitcoin mining" to text-5xl (48px) and reduce the space between the title and the copy below. See example attached

  • adjust font size
  • reduce spacing

CleanShot 0004-09-08 at 21 51 45@2x

Spacing between hero button and the graphic

I noticed we have a huge space between the Hero button and the graphic. Originally, I designed to have the content follow right below the button. I was just curious if there were some internal discussions that perhaps I was not a part of where it was collectively decided to make the hero section full screen heigh?

If not, what are your thoughts on reducing the gap between the button and the image? Here is what it looks like in the design:
CleanShot 0004-09-12 at 00 20 43@2x

vs. current:
CleanShot 0004-09-12 at 00 23 12@2x

Set the body text color in docs

Our text color in docs should be #9BB6D1, currently white.

Via design, the only intentional white text should be the titles: H1-H5. Everything else should be the body color including lists, callouts, quotes, figure captions tables, etc... (not table titles)

CleanShot 0004-09-12 at 08 55 27@2x

Current:
CleanShot 0004-09-12 at 08 56 10@2x

Remove bottom `supporters`, move brains to the upper section and match the design on Figma

We've decided to keep it simple when it comes to showcasing logos of entities and for that reason, we're only showing entities that are currently contributing to the SV2 either financially by funding devs or providing other sort of help (dev help, testing, etc). We're removing entities that have "said they'll do something with SV2 in the future, until they do something, as it's getting hard to determine contributions level and may be unfair to entities that have been doing work for months, some years.

For that reason, it's critical that we update our existing supporters section to match 1:1 the Figma design

Figma https://www.figma.com/file/H42PrGnniKFtbfqHYBGevj/Stratum?node-id=0%3A1

How the section looks now

Screenshot 2022-09-09 at 09 23 39

How the section should look when addressed with a PR

Screenshot 2022-09-09 at 09 20 08

Add tabbed view for multiple configurations

In SV2, there's a variety of possible configurations, currently we're displaying only one "a complete configuration". It would be nice if we could showcase different configs and educate people on what they do and how they can be used.

@cogentgene provided an early concept of how that page may look like, but we still have to put it in Figma.

  • Design tabbed view in Figma
  • Design mockups of configurations
  • Make configurations match the design of the one we already have
  • Implement tabbed view and configurations
  • Write the copy explaining configurations

What we currently have

Screenshot 2022-09-10 at 12 30 21

Early idea of how this section may look like in a tabbed view

cleanshot_0004-09-09_at_19 31 12_2x

Adjust decorative elements.

Since we made so many changes to design in the process, perhaps now is a good time to adjust the decorative element placement. Just as an FYI, the idea is to occupy some of the larger negative spaces to make them look less empty. We utilize decorative elements to sort of glue the design a bit so it doesn't have huge gaps.

Below you will find the final adjustments of the 3 elements. The red squiggles are just to indicate the negative space we are trying to tidy up.

Notice we removed the magenta element as it doesn't really fit anywhere else into the design (early variation). Now we have the orange, teal and the yellow patterns.

Try to use SVGs too if not already ๐Ÿ™

Personally, I would:

  1. position absolute the first graphic in the tabbed content / graphic container
  2. absolute align in why stratum section
  3. absolute align in support section

CleanShot 0004-09-12 at 08 41 12@2x

Remove header menu

With just 2 links in the header menu, I don't really think we need to have a menu until we roll out more content.
Screenshot 2022-09-04 at 8 02 26 AM

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.