Documentation Should Split Programs Out To Individual Pages
The search is very weak on the documentation page; in searching for the following: "sqld" I would expect this page to be the number 1 result: https://www.synergex.com/docs/index.htm#icg/icgChap4Sqlconnectionandxfodbconwindows.htm#sqld%20program instead it is the second result; but I still have to scroll to find the documentation I really care about.
Now compare this to rsynd, for which there is a direct page https://www.synergex.com/docs/icg/icgChap3Rsyndprogram.htm
The root cause is that the rsynd program has its own page whereas for several tools they are sub-pages/embedded into other topics.
We desire that these follow the rsynd pattern and have individual pages.
This mimics Microsoft's Documentation (seen here for tree https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/tree):
Several other programs/commands are affected by this; here is a non-comprehensive list:
- dbl
- dblink
- listelb
- dblproto (this is probably a good compromise)
- gennet40 (utility vs program?)
Instead I had to dig to find this page https://www.synergex.com/docs/versions/v1033g/index.htm#xfnl/xfnlChap10Creatinganassemblyfromthecommandline.htm#Generating%20C%23%20classes%20with%20gencs
2/13/2019 6:19 PM 0
6/10/2019 8:01 PM 0
Feel free to post documentation feedback here in Ideas, and we also encourage you to use the “Comment on this page” link at the bottom of any documentation page to send us feedback there.
6/20/2019 10:16 PM 0
8/9/2019 3:02 PM 0
8/9/2019 6:33 PM 1