Skip to content

Improve the general flow of the website#2

Closed
adamvoss wants to merge 39 commits intojnyrup:best-practicesfrom
adamvoss:best-practices-to-examples
Closed

Improve the general flow of the website#2
adamvoss wants to merge 39 commits intojnyrup:best-practicesfrom
adamvoss:best-practices-to-examples

Conversation

@adamvoss
Copy link

@adamvoss adamvoss commented Oct 1, 2017

The idea to move your best practices to the examples page came to be as I was reviewing for #1. What do you think of the result?

  • Moves the best practices to examples.
  • Minor wording changes to affect tone or perspective
  • Generally ties to make the website more intuitive for uses who do not already know what FluentAssertions is

jnyrup and others added 9 commits September 27, 2017 23:03
- Moves the best practices to examples.
- Minor wording changes to affect tone or perspective
- Generally ties to make the website more intuitive for uses who do not already know what FluentAssertions is
@jnyrup
Copy link
Owner

jnyrup commented Oct 1, 2017

  • I like the merge with examples, keeps the navigation bar tidy.
  • The changes for {index, assertionScope, about}.md might be out of scope for this PR?

I generally like the wording changes for examples.md.
Are you aware that only the sections Assert, StringAssert, CollectionAssert and all but one example from Exception are migration from MSTest?
The remaining sections are examples on more idiomatic use of Fluent Assertions.

@adamvoss
Copy link
Author

adamvoss commented Oct 1, 2017

The changes for {index, assertionScope, about}.md might be out of scope for this PR?

I wanted to show my idea in-context though and felt this was the best way to do it. Since your PR to upstream should probably be squashed a bit, I submitted fluentassertions#646 with my changes to make things easier. I would recommend abandoning this PR and you just making the appropriate changes to move things (as inspired by this) on your own branch.

Are you aware that only the sections Assert, StringAssert, CollectionAssert and all but one example from Exception are migration from MSTest?

Nope, I was not 😀 I was admittedly kind of confused by the "Best Practices" title when I saw it showing changes between assertion libraries.

I'd recommend splitting these two things to avoid this kind of confusion. In that case I'd perhaps keep the MSTest ones under examples and have a Tips page that can be about how to write better FA assertions.

In all cases, I would avoid the "old" vs "new" terminology. Given the potential connotations, I think that would only be appropriate if documenting changes between FluentAssertions versions.

@jnyrup
Copy link
Owner

jnyrup commented Oct 1, 2017

Thanks for all the suggestions, they are now included in 930df67

@jnyrup jnyrup closed this Oct 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants