Reorganize README #1584

verdie-g · 2024-06-30T15:04:55Z

QUALITY CHECKLIST

Changes implemented in code
Complies with our contributing guidelines
Adapted tests
Documentation updated

verdie-g · 2024-06-30T15:06:29Z

README.md

+}
+```
+
+See [our documentation](https://www.jsonapi.net/) for detailed usage and the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications.


Removed the comment about the EmberJS example because I don't think that example is more relevant than others.

It's especially relevant because EmberJS is where JSON:API was born. We attract EmberJS developers looking for "the .NET way" to use JSON:API. This example shows that JADNC is compatible with EmberJS, by providing a fully-working end-to-end example, which includes authentication between EmberJS and .NET. If we had a fully working end-to-end Blazor sample, I'd mention it separately as well.

verdie-g · 2024-06-30T15:07:20Z

README.md

+
+See [our documentation](https://www.jsonapi.net/) for detailed usage and the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications.
+
+## Resources


Maybe it can simply be renamed to "Resources".

That's an overloaded term we should avoid here.

Links? Learning Resources? Learn More?

I like "Learn More"

README.md

verdie-g · 2024-06-30T15:08:35Z

README.md


 # JsonApiDotNetCore
-A framework for building [JSON:API](http://jsonapi.org/) compliant REST APIs using .NET Core and Entity Framework Core. Includes support for [Atomic Operations](https://jsonapi.org/ext/atomic/).
+A framework for building [JSON:API](http://jsonapi.org/) compliant REST APIs using .NET Core and Entity Framework Core. Includes support for the [Atomic Operations](https://jsonapi.org/ext/atomic/) extension.


Added "the ... extension" here to help the reader understand what we are talking about.

Good one. Can you replicate this change to the following files?

/PackageReadme.md

/docs/home/index.html

.../JsonApiDotNetCore.csproj

codecov · 2024-06-30T15:11:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.85%. Comparing base (ae5d0d1) to head (f059fcd).
Report is 14 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1584      +/-   ##
==========================================
+ Coverage   90.80%   90.85%   +0.04%     
==========================================
  Files         348      348              
  Lines       11184    11189       +5     
  Branches     1836     1838       +2     
==========================================
+ Hits        10156    10166      +10     
+ Misses        676      672       -4     
+ Partials      352      351       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

bkoelman · 2024-07-04T15:20:01Z

Thanks, I'll take a look next week.

bkoelman · 2024-07-09T09:39:16Z

README.md

+<p align="center">
+  <a href="https://www.jsonapi.net"><img src="docs/home/assets/img/logo.svg" style="height: 345px; width: 345px"/></a>
+</p>


Please revert this change. I recently removed the centering due to issues on mobile devices.

README.md

bkoelman · 2024-07-09T09:44:10Z

README.md

@@ -55,7 +26,7 @@ public class Article : Identifiable<int>
 }
 ```

-### Middleware
+then add the middlewares


The plural form of middleware is middleware, see https://english.stackexchange.com/questions/257120/middleware-vs-middlewares.

bkoelman · 2024-07-09T09:58:33Z

README.md

-See [our documentation](https://www.jsonapi.net/) for detailed usage.
-
-### Models
+First declare you models


I'm not sure what to exactly provide here. It lacks basic steps such as: create project, install packages, define DbContext, seed the db, start the server, etc. So this isn't a Getting Started with literal steps to follow, but merely a feature showcase.

The current sample is inconsistent, in that it uses int for ID, but the JSON:API snippet contains GUIDs. We may want to adapt to the sample here: provide the steps to produce that output. Or perhaps a simplified form to save screen space. What do you think?

bkoelman · 2024-07-09T10:05:12Z

README.md

+}
+```
+
+See [our documentation](https://www.jsonapi.net/) for detailed usage and the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications.


It's especially relevant because EmberJS is where JSON:API was born. We attract EmberJS developers looking for "the .NET way" to use JSON:API. This example shows that JADNC is compatible with EmberJS, by providing a fully-working end-to-end example, which includes authentication between EmberJS and .NET. If we had a fully working end-to-end Blazor sample, I'd mention it separately as well.

bkoelman · 2024-07-09T10:06:35Z

README.md

+
+See [our documentation](https://www.jsonapi.net/) for detailed usage and the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications.
+
+## Resources


I like "Learn More"

bkoelman · 2024-07-09T10:23:06Z

README.md

Current structure:

## Contributing ## Trying out the latest build ## Development

I'd like to change that to:

## Daily builds (was: Trying out the latest build) ## Contributing ### Build from source (was: Development)

This better matches the level of involvement going down.

Co-authored-by: Bart Koelman <[email protected]>

Reorganize README (fix json-api-dotnet#1567)

0bdfc9c

verdie-g changed the title ~~Reorganize README (fix #1567)~~ Reorganize README Jun 30, 2024

verdie-g commented Jun 30, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

verdie-g commented Jun 30, 2024

View reviewed changes

bkoelman reviewed Jul 9, 2024

View reviewed changes

Update README.md

f059fcd

Co-authored-by: Bart Koelman <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reorganize README #1584

Reorganize README #1584

verdie-g commented Jun 30, 2024 •

edited

Loading

verdie-g Jun 30, 2024 •

edited

Loading

bkoelman Jul 9, 2024

verdie-g Jun 30, 2024 •

edited

Loading

bkoelman Jul 9, 2024

verdie-g Jun 30, 2024

bkoelman Jul 9, 2024

codecov bot commented Jun 30, 2024 •

edited

Loading

bkoelman commented Jul 4, 2024

bkoelman Jul 9, 2024

bkoelman Jul 9, 2024

bkoelman Jul 9, 2024

bkoelman Jul 9, 2024

bkoelman Jul 9, 2024

bkoelman Jul 9, 2024


		See [our documentation](https://www.jsonapi.net/) for detailed usage and the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications.

		## Resources

Reorganize README #1584

Are you sure you want to change the base?

Reorganize README #1584

Conversation

verdie-g commented Jun 30, 2024 • edited Loading

QUALITY CHECKLIST

verdie-g Jun 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

verdie-g Jun 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jun 30, 2024 • edited Loading

Codecov Report

bkoelman commented Jul 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

verdie-g commented Jun 30, 2024 •

edited

Loading

verdie-g Jun 30, 2024 •

edited

Loading

verdie-g Jun 30, 2024 •

edited

Loading

codecov bot commented Jun 30, 2024 •

edited

Loading