Migrate to docs-builder #788
Conversation
…om/telerik/winforms-docs into origin/nadya/winforms-docs-builder
old RadBarcode - removed
There was a problem hiding this comment.
Pull request overview
This PR migrates the documentation to a docs-builder tool, adding necessary configuration files and updating markdown files for compatibility. The changes primarily involve formatting adjustments to code blocks, fixing broken links, correcting heading levels in knowledge base articles, and removing obsolete configuration files.
Key changes include:
- Addition of new docs-builder configuration files (docfx/metadata-config.json and docfx/filterConfig.yml)
- Migration from Jekyll-style includes to custom components (e.g., IntroTable)
- Standardization of code block delimiters and formatting
- Correction of internal anchor links and slug references
Reviewed changes
Copilot reviewed 140 out of 147 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docfx/metadata-config.json | New metadata configuration for docs-builder |
| docfx/filterConfig.yml | API filtering rules for documentation generation |
| introduction.md | Replaced Jekyll include with IntroTable component |
| _config.yml, _staging.yml, _pdf.yml | Removed obsolete Jekyll configuration files |
| Multiple .md files | Updated code blocks from triple backticks to quadruple backticks with XML/powershell identifiers |
| Knowledge base files | Corrected heading levels from # to ## for proper hierarchy |
| Various navigation files | Fixed incorrect slug references and anchor links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1\. In your `nuget.config` file, set the `Username` value to `api-key` and the `ClearTextPassword` value to an environment variable name: | ||
|
|
||
| #### __[XML]__ | ||
| ````XML |
There was a problem hiding this comment.
Code block delimiter inconsistency. Line 66 uses XML while other similar blocks in the file use xml (lowercase). Standardize to use lowercase identifiers for consistency.
| ````XML | |
| ````xml |
| * Register<T>() where T : RadToastNotificationActivatorBase | ||
| * Register<T>(string exePath, string shortcutName, string aumid) where T : RadToastNotificationActivatorBase | ||
| * `Register<T>()` where T : RadToastNotificationActivatorBase | ||
| * `Register<T>(string exePath, string shortcutName, string aumid)` where T : RadToastNotificationActivatorBase |
There was a problem hiding this comment.
Method signatures should use HTML entity < and > for angle brackets instead of backticks with raw < and > characters to ensure proper rendering in all contexts.
| * `Register<T>(string exePath, string shortcutName, string aumid)` where T : RadToastNotificationActivatorBase | |
| * `Register<T>(string exePath, string shortcutName, string aumid)` where T : RadToastNotificationActivatorBase |
| slug: winforms/ribbonbar/getting-started/adding-and-removing-tabs-and-ribbonbar-groups | ||
| tags: adding,and,removing,tabs,and,ribbonbar,groups | ||
| published: True | ||
| published: False |
There was a problem hiding this comment.
This page is marked as unpublished (published: False). If this is intentional for the migration, consider adding a comment explaining why, or verify if it should be published: True.
| published: False | |
| published: True |
|
|
||
| |HeaderNavigationMode|Design| | ||
| |----|----| | ||
| |Zoom|| |
There was a problem hiding this comment.
The table row for Popup mode and its associated image reference were removed. If this was intentional, ensure the corresponding image file is also removed from the repository to avoid orphaned assets.
| # WinForms BarcodeView Overview | ||
|
|
||
| **RadBarcodeView** can be used to create and show barcodes. You can generate and visualize barcodes in a machine-readable format via the **RadBarcodeView** control by providing numeric or character data. | ||
|
|
There was a problem hiding this comment.
A note about the obsolete RadBarcode control was removed. Ensure that any migration documentation or deprecation notices are adequately covered elsewhere, as users may need guidance on transitioning from the old control.
| > **Migration Note:** | |
| > The previous **RadBarcode** control is now obsolete and has been replaced by **RadBarcodeView**. If you are upgrading from an older version of Telerik UI for WinForms, please refer to the [RadBarcode to RadBarcodeView Migration Guide](https://docs.telerik.com/devtools/winforms/controls/barcodeview/migration-from-radbarcode) for details on transitioning your projects and understanding the key differences. |
Add docs-builder.yml
Edit md files for the tool