Main extensibility docs improvements updated #25
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…loper experience of the api-docs across all RWS products. Make reference to: https://rws-dev.atlassian.net/wiki/spaces/LTApp/pages/930645143/Developer+Documentation+Improvement+Proposal
….com/ Removed the specific release version of docfx. Lastest template supports latest version of docfx
Update docfx to include post processor to update the env variables 'EnvironmentVariableProcessor'
- Updated links in Termbase templates, Termbase, Translation Memory import/export, Translations, and Webhooks documentation to point to the new API structure. - Added a new PowerShell script (convert-reference-links.ps1) to automate the conversion of ../reference links in markdown files to the new ../api structure. - Added a second PowerShell script (convert-contract-links.ps1) to rename markdown links in contract files and adjust their URLs to the new format. - Updated the table of contents to include the Translations section. - Created a Requirements.md file detailing the new scripts and their functionalities.
…ct and reference links - Updated Webhook payload documentation links from .md to .html format in Webhooks.v1.json. - Added PowerShell script (convert-contract-links.ps1) to convert markdown links in contract JSON files to HTML links, handling both .md to .html conversions and JSON reference paths. - Added PowerShell script (convert-reference-links.ps1) to convert ../reference/*.json links in markdown files to ../api/*-fv.html links, supporting both paths and components/schemas references.
# Conflicts: # articles/Extensibility/api/Extensibility-API.v1.json # articles/Extensibility/docs/Whats-New.md # articles/Extensibility/docs/appManagement/Approvals.md # articles/Extensibility/docs/appManagement/Installing.md # articles/Extensibility/docs/appManagement/Publishing.md # articles/Extensibility/docs/appManagement/Registering.md # articles/Extensibility/docs/appManagement/Retiring.md # articles/Extensibility/docs/appManagement/Sharing.md # articles/Extensibility/docs/appManagement/Updating.md # articles/Extensibility/docs/consumer/Automatic-Task-App-consumer-guide.md # articles/Extensibility/docs/consumer/MT-App-consumer-guide.md # articles/Extensibility/docs/development/App-Descriptor.md # articles/Extensibility/docs/development/App-Versioning.md # articles/Extensibility/docs/development/Automatic-Task-App-development-guide.md # articles/Extensibility/docs/development/Deployment-Strategy.md # articles/Extensibility/docs/development/MT-App-development-guide.md # articles/Extensibility/docs/development/Multi-Region.md # articles/Extensibility/docs/development/Preview-App-development-guide.md # articles/Extensibility/docs/development/Request-Authentication.md # articles/Extensibility/docs/development/Trados-Cloud-API.md # articles/Extensibility/docs/development/UI-App-custom-elements-locations.md # articles/Extensibility/docs/development/UI-App-development-guide.md # articles/Extensibility/docs/development/Verification-App-development-guide.md # articles/Extensibility/docs/development/Webhooks.md # articles/Extensibility/docs/development/blueprints/Dot-Net-Migration-Blueprint.md # articles/Extensibility/docs/development/blueprints/Java-Migration-Blueprint.md # articles/Extensibility/docs/development/blueprints/Testing-with-Docker.md # articles/Extensibility/docs/development/blueprints/Testing.md # articles/Extensibility/toc.yml # articles/LCPublicAPI/api/Global-Public-API.v1-fv.html # articles/LCPublicAPI/api/Global-Public-API.v1.json # articles/LCPublicAPI/api/Global-Public-API.v1.md # articles/LCPublicAPI/api/Public-API.v1-fv.html # articles/LCPublicAPI/api/Public-API.v1.json # articles/LCPublicAPI/api/Public-API.v1.md # articles/LCPublicAPI/api/Webhooks.v1-fv.html # articles/LCPublicAPI/api/Webhooks.v1.json # articles/LCPublicAPI/api/Webhooks.v1.md # articles/LCPublicAPI/docs/API-rate-limits.md # articles/LCPublicAPI/docs/Authentication.md # articles/LCPublicAPI/docs/Basic-project-creation-flow.md # articles/LCPublicAPI/docs/Create-projects.md # articles/LCPublicAPI/docs/Export-quote-report.md # articles/LCPublicAPI/docs/File-formats.md # articles/LCPublicAPI/docs/Headers-considerations.md # articles/LCPublicAPI/docs/How-to-multipart.md # articles/LCPublicAPI/docs/How-to-report-an-issue.md # articles/LCPublicAPI/docs/Known-Issues.md # articles/LCPublicAPI/docs/Language-Cloud-APIs-for-Postman.md # articles/LCPublicAPI/docs/Multi-region.md # articles/LCPublicAPI/docs/Public-API-Management-Process.md # articles/LCPublicAPI/docs/Service-credentials.md # articles/LCPublicAPI/docs/Use-fields-in-your-requests.md # articles/LCPublicAPI/docs/Whats-New.md # articles/LCPublicAPI/docs/Whats-deprecated.md # articles/LCPublicAPI/docs/api-clients/java/Java-Client.md # articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md # articles/LCPublicAPI/docs/api-clients/net/NET-Client.md # articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md # articles/LCPublicAPI/docs/termbase/Termbase-entries.md # articles/LCPublicAPI/docs/termbase/Termbase-import-export.md # articles/LCPublicAPI/docs/termbase/Termbase-templates.md # articles/LCPublicAPI/docs/termbase/Termbase.md # articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md # articles/LCPublicAPI/docs/translations/Translations.md # articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md # articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md # articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md # articles/LCPublicAPI/toc.yml # index.md
rpascalsdl
approved these changes
Nov 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.