Combine define generate Help file with Docfx

chuongmep commented 1 year ago

If this is an issue for Dynamo Core, please submit your issue on the Dynamo Core issues page or if this is an issue for Dynamo for Revit, please post your issue on the Dynamo for Revit Issues page.

If this issue is not a Wishlist request, please check the Dynamo forum, and start a thread there to discuss your issue.

What improvement/feature would you like to see in Dynamo?

Example I have this document online : https://chuongmep.github.io/OpenMEP/api/OpenMEP.ConnectorManager.ConnectorManager.html With Method defind for pictute example : https://github.com/chuongmep/OpenMEP/blob/ec4dee35ac75a515e158f65842ef9f72a2c28df8/OpenMEP/ConnectorManager/ConnectorManager.cs#LL19C5-L19C5

I don't want defind two time one for help file and one for document online, view this isssue : https://github.com/DynamoDS/Dynamo/issues/13648#issuecomment-1465170738

How would you see this improvement/feature working?

User just need defind same format with docfx and then can resolve problem for both

Please provide any sketch/mock-up or video of your requested improvement/feature

Example:

    /// <summary>
    /// return connector manager of element
    /// </summary>
    /// <param name="element">element</param>
    /// <returns name="ConnectorManager">Autodesk.Revit.DB.ConnectorManager</returns>
    /// <example>
    /// ![](../OpenMEPPage/connectormanager/dyn/pic/ConnectorManager.GetConnectorManager.png)
    /// </example>

///

This will be generate same with docfx include code, picture, markdown,...

Amoursol commented 1 year ago

@chuongmep just to confirm, you are looking for Dynamo to also support the .docfx file format as well as the current Markdown approach? 😊

chuongmep commented 1 year ago

@Amoursol yes, at the moment my process break with Markdown define in dynamo, it is not same and I don't have any way to connect document guideline.

Amoursol commented 1 year ago

@mjkkirschner any reason why we couldn't also support the docfx format? Assuming we'll also need to add it to the HTML sanitizer workflow? So just a time-cost?

mjkkirschner commented 1 year ago

markdown is simpler and wider adopted than docfx, docfx requires use of a library and it generates a static site on the other end, unclear if it's appropriate for our use case without investigation.

It may perform some kind of sanitization as well but I have no idea.

chuongmep commented 1 year ago

Docfx also support markdown when I insert a path markdown to example, why we can see this is a not wider adopted ? I can write a acticle to explain for one node and link with online documentation.

Get Outlook for iOShttps://aka.ms/o0ukef

From: Michael Kirschner @.> Sent: Monday, March 13, 2023 11:12:41 PM To: DynamoDS/DynamoWishlist @.> Cc: Chuong Ho @.>; Mention @.> Subject: Re: [DynamoDS/DynamoWishlist] Combine define generate Help file with Docfx (Issue #236)

markdown is simpler and wider adopted than docfx, docfx requires use of a library and it generates a static site on the other end, unclear if it's appropriate for our use case without investigation.

It may perform some kind of sanitization as well but I have no idea.

— Reply to this email directly, view it on GitHubhttps://github.com/DynamoDS/DynamoWishlist/issues/236#issuecomment-1466338699, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AHNKLAGRLCGHDIJS4ZYORALW342OTANCNFSM6AAAAAAVYMJ46M. You are receiving this because you were mentioned.Message ID: @.***>

Amoursol commented 1 year ago

@chuongmep we hear you on how useful it would be and will keep it in mind when we loop back onto the Documentation piece.

Currently we use a Markdown input that goes through an HTML sanitizer to create the HTML pages in order to meet security obligations. Any further improvement would also need to meet those standards.

DynamoDS / DynamoWishlist