DevOpsWikiStrategy Class

public class DevOpsWikiStrategy : AddressingStrategy, ILanguageSpecific, IContextualAddressingStrategy

The DevOpsWikiStrategy class provides a structured approach for organizing and resolving documentation pages hosted on an Azure DevOps Wiki. It translates code references into wiki-friendly URLs and file paths, ensuring compatibility with Azure DevOps' wiki structure.

The strategy organizes API documentation content into namespace and type pages. Namespaces receive dedicated pages, with types documented on separate pages nested under their namespaces. Type members such as methods and properties are documented on their declaring type's page, accessible through URL fragments for efficient navigation while maintaining a clean wiki structure.

Content organization for topics follows a simple hierarchical structure based on parent-child relationships. Topic paths are constructed using encoded titles, with child topics nested under their parents to maintain a clean and navigable wiki structure.

Key features of the DevOpsWikiStrategy addressing strategy include:

• Compatibility with Azure DevOps Wiki linking conventions
• Namespace-then-type hierarchy for intuitive API documentation navigation
• URL fragments for type members to maintain clean page structure

This strategy works well for teams that want to maintain their documentation directly within their Azure DevOps environment, providing seamless integration between code and narrative documentation that's easily accessible to all team members.

Public instance members can be considered thread-safe if neither DevOpsWikiOptions.MainTopicId nor DevOpsWikiOptions.ApiTopicId is set in the construction options of the instance. If either property is set, instance members are only thread-safe if the instance is fully initialized (that is, IContextualAddressingStrategy.InitializeWithContext(IDocumentationContext) has been called) before any other method is accessed, and there is no concurrent access during or before initialization.

The class is not thread-safe otherwise, because it contains a mutable context field and uses lazy initialization that depends on this field, without synchronization.