SObject support (Markdown subcommand)

[cesarParra]

Overview

Provides support for generating documentation for Custom Objects (SObjects).

Tasks

Parsing

• Parse XML .object
  • Parse label
  • Parse description
  • Parse visibility
    • Must either not be there or be public
  • Deployment status
    • Must be deployed
  • Validation
• Parse XML .field
  • Parse field name
  • Parse description
  • Validation

Markdown support

Here is an example of what we want to output: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_accountcontactrelation.htm

• Read files
  • Read .object meta files
  • Read .field meta files
• Data pipeline
  • Parse
  • Filter non-public/non-published
  • To Renderable
  • Compile through template
    • Hooks support
• Write files
• Config
  • Configurable group name (for reference guide)
  • Ability to turn on/off reading SObjects