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

Features page #5

Open
jubianchi opened this issue Jan 4, 2016 · 6 comments
Open

Features page #5

jubianchi opened this issue Jan 4, 2016 · 6 comments

Comments

@jubianchi
Copy link
Member

I think the "Features" page contains too much things. We should split it in several pages:

  • The "Features" page would just be an entry point with a simple list (titles and short descriptions)
  • Each child page will bring details on a single feature

The tree would look like:

+ Features
|-- Flexible structure
|-- Execution engines
|-- Vocabulary
|-- Meaningful asserters
|-- Mocks
|-- Virtual file system
|-- Reports
|-- Loop and autorun modes
|-- Configuration file in PHP
|-- Third-party integration
|-- Fast
|-+ Extensions
  |-- ruler-extension
  |-- json-schema-extension
  |-- ...

Doing so will allow us to write more detailed contents and it could perhaps become something like Cookbooks to help users take advantage of those features.

Moreover, I think we should rename the "Vocabulary" and "Fast" sections but honestly I don't know how to name them.

@mikaelrandy
Copy link
Member

👍

@Hywan
Copy link
Member

Hywan commented Jan 5, 2016

👎
Users will have to click twice. This is wrong. If the page is too long, we have to reduce section's size and add links to a detail page. Thoughts?

@Hywan
Copy link
Member

Hywan commented Jan 5, 2016

Or, instead of a list, we must have a grid with self-describing icons. We are not designers, don't forget that :-/.

@jubianchi
Copy link
Member Author

reduce section's size and add links to a detail page

This is what I meant: less text ont the "Features" page and link to detailed pages. In its current state, I doubt users will ever read the whole page.

@Hywan
Copy link
Member

Hywan commented Jan 5, 2016

Less text, agree. Just a simple list, not agree :-).

@Grummfy
Copy link
Member

Grummfy commented Oct 5, 2017

So about this, we all agree that we need to change in a direction or another.

Today we got this structure :

  • Flexible structure
  • Execution engines
  • Vocabulary
  • Meaningful asserters
  • Mocks
  • Virtual file system
  • Reports
  • Loop and autorun modes
  • Configuration file in PHP
  • Third-party integration
  • Fast
  • Extensions

What I will do is this

  • Flexible structure
  • Execution engines
  • Vocabulary Structural keywords || Writing types
  • Meaningful asserters
  • Mocks
  • Virtual file system
  • Reports
  • Third-party integration
  • Fast Some key numbers
  • And more
    • summary of the links
    • link to extension
    • link to some sub pages

Sub pages:

  • Advanced feature :
    • Loop and autorun modes
    • Debug mode
  • Configuration file in PHP

@Grummfy Grummfy mentioned this issue Oct 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants