Logo: Relish

  1. Sign in

Project: relish

Readme pages

If you put a readme.md file in the root of your features directory, that page
will be rendered by default when you view the project.

If you don't, you'll see a blank slate message suggesting that you add one.

In fact, this works for any sub-directory within your features directory.

Scenarios
Visitor sees readme in the root
Given
a project with a readme in "readme.md"
When
I view the page for the project
Then
I should see the readme file rendered as HTML
Visitor sees readme in a directory
Given
a project with a readme in "admin/readme.md"
When
I view the page for the project
And
I follow the link to the "Admin" topic in the left nav
Then
I should see the readme file rendered as HTML
Visitor sees a list of pages but no blank slate message in the root
Given
a project with no readme
But
the project has a couple of other topics in the root
When
I view the page for the project
Then
I should not see a message suggesting that I add a readme
And
I should see a list of the topics in the root directory
Collaborator sees a blank slate message in the root as well as list of pages
Given
a project with no readme
But
the project has a couple of other topics in the root
And
I am signed in as a collaborator on the project
When
I view the page for the project
Then
I should see a message suggesting that I add a readme
And
I should see a list of the topics in the root directory
Collaborator sees blank slate in a directory
Given
a project with a feature in "admin/amazing.feature"
And
I am signed in as a collaborator on the project
When
I view the page for the project
And
I follow the link to the "Admin" topic in the left nav
Then
I should see a message suggesting that I add a readme
And
I should see a list of the topics in the "admin" directory

Last published about 7 years ago by mattwynne.