Skip to content

Conversation

@rpascalsdl
Copy link
Collaborator

trying to fix merge problems for extensibility PR

* Enhance the consistency, usability, maintainability, and overall developer 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

* Remove redundant plugins folder - inherited from Studio team.

* Resolve bug in redirecting to the landing page https://developers.rws.com/
Removed the specific release version of docfx.  Lastest template supports latest version of docfx

* Use dotnet to install docfx - resolves dependencies automatically
Update docfx to include post processor to update the env variables 'EnvironmentVariableProcessor'

* updated to newer version of docs and contracts

* Update API documentation links and add scripts for link conversion

- 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.

* Fix webhook documentation links and add scripts for converting contract 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.

* LTLC-127082-public-api

* Update latest from Public API Main

* Update styling

* Fix incorrect antlr code display

* Update styling and fix links

* Fix 2 more links

---------

Co-authored-by: Patrick Andrew Hartnett <phartnett@sdl.com>
Co-authored-by: Radu Pascal <rpascal@sdl.com>
Co-authored-by: Rares Tritean <tritean@gmail.com>
@rpascalsdl rpascalsdl closed this Nov 18, 2025
@rpascalsdl
Copy link
Collaborator Author

failed experiment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants