Using Helper Tools

Here you can find a list of available helper tools that make life easier.

All helper tools are actually rake tasks. The implementation of the rake tasks is available in ajax_docs/RakeFile.

Sync Documentation from XAML Documentation

Important: Make sure that the local repository (ajax-docs) is configured to use SSH connection, and that your account have access to the xaml-docs repository.

In the root of ajax-docs, run:

rake xaml_docs

Build Inheritance Tree in Client-side API Articles

Note, by default the task will build the inheritance tree of all *.md files located in the api/client folder without overriding the existing slugs, and trees. To fine-tune the tool, see Optional Configurations.

In the root of ajax-docs, run:

rake build_inheritance

Optional Configurations

The configuration file is located in helper_tools folder—build_inheritance.yml file.

Default structure:

path: "api/client"
files: []
override_inheritance: false
override_slug: false

Options' description:

• path—configures where the client-side API reference is located;

• files—is an array of files, which to be processed;

  If the array is empty, all files in the path will be processed.

• override_inheritance—configures whether to override the already built inheritance tree(s);

• override_slug—configures whether to override the automatically generated slugs.