Should there be an order in the ToC of the docs?
Closed this issue · 7 comments
I don't know if there's any particular ordering at the moment, but perhaps there should be an ordering? Alphabetical, or per group of scenarios perhaps?
Originally I was thinking about ordering them in terms of use. The basic cases first and then the more advanced ones that are used less often.
But that's rather arbitrary so perhaps alphabetical is more appropriate. But the titles will need to be changed to be easier to find.
If you want to take a stab at it I wouldn't object.
Ok I'll have a look :)
Would this be an idea?
{
"Name": "The .NET Core ORM Cookbook",
"Source": ".",
"Destination": "..\\..\\docs",
"IncludeSource": "Includes",
"Theme": "Light",
"Footer": "The ORM Cookbook. <a href='https://github.com/Grauenwolf/DotNet-ORM-Cookbook' target='_blank'>Visit us at GitHub</a>.",
"ConvertLocalLinks": "true",
"Pages":
{
"__index": "index.md",
"ORMs": {
"ADO.NET": "ADO.md",
"Chain": "Chain.md",
"Dapper": "Dapper.md",
"Entity Framework 6": "EF6.md",
"Entity Framework Core": "EFCore.md",
"LLBLGen Pro": "LLBLGenPro.md",
"NHibernate": "NHibernate.md",
"RepoDb": "RepoDb.md",
"ServiceStack": "ServiceStack.md"
},
"FAQ": "FAQ.md",
"Standard CRUD scenarios":
{
"Operations on a single entity type": "SingleModelCrud.md",
"Operations on sets": "MultipleCrud.md",
"Operations on a graph of multiple entity types": "ModelWithChildren.md",
"Operations on immutable entities": "Immutable.md",
"Handling failures and exceptions": "TryCrud.md",
"Operations with a Foreign Key based Lookup Table":
{
"FK Lookup table using an integer-based Foreign Key": "ModelWithLookupSimple.md",
"FK Lookup table using an object-based Foreign Key": "ModelWithLookupComplex.md"
},
},
"Fetching data scenarios":
{
"Projecting with a Join": "Joins.md",
"Reading from Views": "Views.md",
"Row Counts": "RowCount.md",
"Paging Results": "Pagination.md",
"Populate DataTable": "PopulateDataTable.md",
"Reading a Salar Value from a Row": "ScalarValue.md",
"Reading a Single Column from a Table": "SingleColumn.md",
},
"Advanced scenarios":
{
"Async Operations": "SingleModelCrudAsync.md",
"Upsert": "Upsert.md",
"Partial Updates": "PartialUpdate.md",
"Batch Inserts with Large Collections": "LargeBatch.md",
"Bulk Inserts": "BulkInsert.md",
},
"Sorting scenarios":
{
"Basic Sorting": "Sorting.md",
"Sorting by Dynamically Chosen Columns": "DynamicSorting.md"
},
"Stored procedure scenarios":
{
"Basic Stored Procedures": "BasicStoredProc.md",
"Working with Transactions": "Transactions.md"
}
}
}
Of course the titles of the individual pages (and links to them) have to be updated as well.
That certainly looks nicer than what we have now.
Ok, will add a PR tomorrow (plus regenerated doc files)! :)