Documentation #152
Documentation #152
Conversation
|
Preview: https://orchardcorecommerce.readthedocs.io/en/ag-docs/ Let me know what you think of it and which kind of doc structure we could adopt. Ex:
|
|
Then, I will be able to create a sub domain like commerce.orchardcore.net pointing to the docs site. |
src/README.md
Outdated
| @@ -0,0 +1,76 @@ | |||
| # Orchard Core Commerce | |||
There was a problem hiding this comment.
Did you copy the README.md from the repository root? Why? This will be a maintenance problem.
There was a problem hiding this comment.
Yes, I copied it as in OC because it becomes the root of the documentation.
Next goals will be to:
- Split the infos in multiple pages.
- Make the root Readme lighter. Ex: Just description, badges and link to doc site.
There was a problem hiding this comment.
We need to keep docs/README.md, it will be the first page of the docs site.
There was a problem hiding this comment.
Please don't resolve the conversations yourself, it makes reviewing harder as I have to look through the closed convos.
Check out this issue, looks like you can include files outside of the docs directory using the Snippets extension. Please try that for docs/README.md. I also suggest renaming it to docs/OrchardCore.Commerce.md so when we include readmes for the other libraries (or any future modules) it will be consistent.
There was a problem hiding this comment.
Snippet works but we can't refer to the root Readme.
There was a problem hiding this comment.
Have you read the specific comment that I've linked in the issue? It explains where you have to put the redirect: inside the md file, not in the mkdocs.yml. You should have a file like this: https://github.com/pawamoy/duty/blob/master/docs/index.md
There was a problem hiding this comment.
Ok, done. It seems to work:
https://orchardcorecommerce.readthedocs.io/en/ag-docs/
There was a problem hiding this comment.
Error: MD041: first-line-heading: First line in a file should be a top-level heading. Rule information: https://github.com/DavidAnson/markdownlint/blob/v0.26.2/doc/Rules.md#md041
There was a problem hiding this comment.
Great! I've disabled markdownlint for the file.
| @@ -0,0 +1,8 @@ | |||
| <Project Sdk="Microsoft.NET.Sdk"> | |||
There was a problem hiding this comment.
Could you explain why we need the csproj file?
Nothing in it will be built, but it will create a useless NuGet package once #151 is merged.
There was a problem hiding this comment.
Could you explain why we need the csproj file?
To make it appear in the solution.
Nothing in it will be built, but it will create a useless NuGet package once #151 is merged.
It shouldn't be built because of the <IsPackable>false</IsPackable>
There was a problem hiding this comment.
Unfortunately I found out after merge that this breaks dotnet pack, so I have to delete the csproj file after all.
see https://github.com/OrchardCMS/OrchardCore.Commerce/runs/7962504898?check_suite_focus=true#step:4:4202
|
Thanks, the preview looks nice. Should we also have a workflow for updating this after every merge to I agree with "1 Readme per feature / library.", incidentally I have already added stub readmes for the two existing libraries in #151 , e.g. here. For now "Getting Started" is short ("Setting up your dev environment" in the main readme) so it doesn't need to be separated. But later we can turn it into a separate page as you suggest. |
This reverts commit 852a37e.
Add MkDocs