workday / doc_my_routes Goto Github PK

I'd like to be able to link directly to individual endpoints in the documentation. This helps with communication among team members.

I would suggest placing an anchor element beside each endpoint with a href for the endpoint. Something like:

<a href="[CURRENT_URL]#[VERB][PATH]>[SOME SORT OF LINK ICON</a>

The HTML5 details tag is not supported on Firefox and IE.

We can add an option emulate_details_tag that would inject in the full page a custom Javascript that emulates the folding behaviour of the details tag.

If the option is set, that Javascript is then included in the page.
If format = :partial_html is provided, the Javascript is shipped as well on a separate file.

It's then up to the user to decide whether she wants a fully js-free page or broader compatibility.

When the option is set, instead of generating a full HTML page we will generate a div that can be embedded in custom code.

For instance:

DocMyRoutes.configure do |config|
  ...
  config.render_as_partial = true
end

will generate an embedded partial.