MapsterMapper
Docs: add docfx docs from wiki
@DocSvartz we would need the mapster logo in a suitable size for both:
- [x] top navigation bar
_pathLogoImage - [x] icon in the browser tab
_pathFavIconImage
Could someone of you get us them? I removed them temporarily from the build of docfx, but it looks better with them😅
- [x] Please check the code samples and added comments in the
Configuration.mdfile, I am not Sure if this is really configuration or more Settings area - [x] after this please check the headers and levels of those in the
docs/api/Reference.mdwhich is your api doc until we would have real api docs generated throughdocfx metadata docs/docfx.jsoncommand
By the way, the PR introduces also:
- Commitsar CI - requiring Concentional commit format
Link to it in the added
./Contributingwhich you see failing in here because the wiki repo was not using them and the"IMapFrom"File naming issue did not allow me even to edit or squash the two commits since I am on a Windows Computer 😅 - csharp-docs agent/prompt
for those of you writing code frequently, check out the new added contents in
./.github/*added some nice little helper for you from the awesome-copilot repo, which you can use in e.g. vs code 🚀 - extensions recommendations for vscode (so far no CI Workflow for those installed)
- markdownlint
- cspell
- powershell
- powershell scripts for simplify clean & build of docfx docs locally, to validate your eventual changes
after this please check the headers and levels of those in the docs/api/Reference.md which is your api doc until we would have real api docs generated through docfx metadata docs/docfx.json command
@DevTKSS It works. 👍 Or did you mean something else?
The only thing I'd like to do is set links to a specific section of the page, if possible.
Like this:
https://github.com/MapsterMapper/Mapster/wiki/Custom-mapping#mapping-with-condition
But this is not necessary and can be done later.
@DocSvartz
The only thing I'd like to do is set links to a specific section of the page, if possible. Like this: after this please check the headers and levels of those in the docs/api/Reference.md which is your api doc until we would have real api docs generated through docfx metadata docs/docfx.json command https://github.com/MapsterMapper/Mapster/wiki/Custom-mapping#mapping-with-condition But this is not necessary and can be done later.
The new path will be /docs/ not longer /wiki/ just for your note ;)
But of course, that will work, docfx is using Markdig syntax by default, so feel free to suggest a Change for this in the Files you want them or you could also (not tried this by now) use the online github.dev editor while you are on this PR side and tap on . on your Keybord to open it 👍
the /Configuration.md bulletpoint is still open from what I am seeing, did you find time to check on this by now?
@DevTKSS
the /Configuration.md bulletpoint is still open from what I am seeing, did you find time to check on this by now?
I check it and left a review comment. I'm happy with everything.
@DocSvartz I dont see an open comment, the only One I seen was in Contributing.md 🤔 did you click on send after adding? 😅
I updated the image urls now. If you are fine with the updates, would you fill out this for on the changed files Tab?
@DocSvartz would you lick on the ... and give me the link? I assume that you did add them not here, then on my repo fork maybe, but I never seen this 😅 therefore, would be the easiest way.
It don't have any links either. 😅 https://github.com/MapsterMapper/Mapster/pull/834/files/1e000af6e47dc1de8cbd07a5b75188eeb7e5767b
I'll try to delete it.
Please check the code samples and added comments in the Configuration.md file, I am not Sure if this is really configuration or more Settings area
@stagep This question is more for you, as the only native English speaker here.
I perceive the word configuration in relation to a software product as the process of correctly and effectively setting settings.😅
@DevTKSS Strange, I left it on the same day as the comment on CONTRIBUTING.md 🤔 Maybe I just used a different device. 😂
@DocSvartz @DevTKSS reviewing the documentation is going to take a while. We should move forward with publishing as it cannot be any worse that it currently is, as it is based on the current documentation. Then individual pages can be reviewed and edits made.
@DocSvartz @stagep the docs gh action will currently only run, if it's pushing to master, just for your information. If you need me to update this to development branch, let me know!