specs.next | beta.specs.filecoin.io

[hugomrdias]

/cc @yiannisbot

[olizilla]

@jbenet work on the specs upgrade is going on in this PR. Latest rendered preview is here https://deploy-preview-969--fil-spec-staging.netlify.app/ (the deploy/netlify status check details will always have the most recent rendered preview)

[daviddias]

Some nits on usability:

[daviddias]

[olizilla]

can you make these always be expanded

@daviddias can you state the problem you are feeling? Can you frame your feedback in terms of what you need to be productive? Is it that you can't find sections without seeing an over view of all the headings on the left?

can we haz algolia search

YES

spinner madness!

I feel the same. It gives me an sense that something is failing to load. I think this will change as the dashboard settles.

replace this section with a link to the grid

We will iterate on how to show the spec status in each section, and include a link to the dashboard

[daviddias]

@daviddias can you state the problem you are feeling? Can you frame your feedback in terms of what you need to be productive? Is it that you can't find sections without seeing an over view of all the headings on the left?

That's correct. And given that now each section is a separate page, I have to wait for the whole HTTP RTT to get the next page, which makes skimming and understanding where things are and how they are organized much harder.

The previous page solved this with a slider

[yiannisbot]

replace this section with a link to the grid

We will iterate on how to show the spec status in each section, and include a link to the dashboard

We will certainly include a link to the grid/dashboard. However, I think it would be useful to have a summarising, e.g., per section, overview here. I'm not clear whether the summarising one should be in the form it is now, or as a table/grid, but let's iterate on this to get feedback.

[davidad]

My feedback:

1. Using an animated icon as a symbolic glyph goes against UX guidelines, which point out that animation draws the user's attention, so it should be unobtrusive and brief (source), or in response to user actions or state transitions (source).
2. It would be nice to be able to expand multiple parts of the sidebar at once; I'd also like an "expand all" button.
3. The search function doesn't show me where on the matching page the match was found, neither by highlighting or scrolling. I can do a Cmd-F, but now I have to search for the same thing twice.
4. There's no "show as a single page" to enable Cmd-F alone to search the whole spec.

I see that all these points have basically already been covered by @daviddias but hope it's helpful to hear it from another user.

[dignifiedquire]

This tiny embedded frame of a PDF is not really useful, either this should be converted into spec content, or just an external link

[dignifiedquire]

It would be great to have a light mode, I know there are a lot of fans of dark mode, but I feel it is quite hard to read for longer forms of text.

[nicola]

Same here, light mode please, it is dark and the text is too gray for me :(

[hugomrdias]

Thank for all the feedback keep it coming !! We will improve based on it, you can already see here https://github.com/filecoin-project/specs/projects/8 our planing.

[hugomrdias]

This PR will be closed in favor of the beta branch which will be the default branch from now on. The previous setup still lives in the master branch until we finish the beta.

For more feedback please use this issue #992
Thank you.