01_08_documentation Podcast By  cover art

01_08_documentation

01_08_documentation

Listen for free

View show details

About this listen

Working on this week:
  • Kevin made uSync triggers : https://github.com/KevinJump/uSyncTriggers
  • and Matt released (but forgot to mention) the Vendr lite licence model: https://vendr.net/vendr-lite/
Documentation tools
  • mkdocs  : https://www.mkdocs.org/
  • readthedocs : https://readthedocs.org/
  • docusaurus : https://docusaurus.io/

The tool Matt is using to build his reference docs (with some custom code)  is Mono.Cecil : 

  • https://www.mono-project.com/docs/tools+libraries/libraries/Mono.Cecil/

Kevin was showing his age,when he was talking about ndocs (& he said ngdocs) which is dead but sorely missed documentation generator for visual studio xml doc files. 

  • http://ndoc.sourceforge.net/
  • Sandcaslte is the Microsoft  project that replaced it, and if we are honest Kevin hasn't forgiven them yet to be able to objectively tell you if its any good.

The command switch  /doc to turn on documentation was once again Kevin showing his age - this use to be a switch (or something like it), now it is automatically added when you tick XML Documentation file in your project configuration

vale linter  
   - https://github.com/errata-ai/vale
   - Example of how UmbracoDocs uses vale https://github.com/umbraco/UmbracoDocs/blob/main/.github/vale-linter.yml

Collapse comments - There isn't a built in shortcut 😞 - but there is an extension that adds one https://marketplace.visualstudio.com/items?itemName=MattLaceyLtd.CollapseComments

structuring your documentation

What you don't tell you about documentation :   https://documentation.divio.com/

UI Examples package / demo video

UI Examples package
   - https://our.umbraco.com/packages/developer-tools/ui-examples/

Video of Migration to Multi-targeted package
   - https://youtu.be/W9IvX9MmoMo

Music from Uppbeat
License code: D8SGCQHI1KO8DKKG

adbl_web_global_use_to_activate_T1_webcro805_stickypopup
No reviews yet