Skip to content

Extensibility docs improvements #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Extensibility docs improvements #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
2dfb7b7
Enhance the consistency, usability, maintainability, and overall deve…
Impertatore Apr 1, 2025
cc16257
Remove redundant plugins folder - inherited from Studio team.
Impertatore Apr 1, 2025
f2541f8
Resolve bug in redirecting to the landing page https://developers.rws…
Impertatore Apr 3, 2025
3f9bf27
Use dotnet to install docfx - resolves dependencies automatically
Impertatore Apr 8, 2025
c87735d
updated to newer version of docs and contracts
rpascalsdl Oct 6, 2025
263d371
Update API documentation links and add scripts for link conversion
rpascalsdl Oct 7, 2025
d71e85b
Fix webhook documentation links and add scripts for converting contra…
rpascalsdl Nov 4, 2025
38cc86f
Push new branch
mdipsan Nov 4, 2025
57e0ee9
Merge branch 'main' into main_extensibility_docs_improvements
mdipsan Nov 4, 2025
ec15493
Some fixes after the merging from main
mdipsan Nov 4, 2025
48ff180
Update extensibility docs
mdipsan Nov 4, 2025
ad4fd96
Update extensibility doc links to contract
mdipsan Nov 4, 2025
4aa7f8c
Fix old broken linkds
mdipsan Nov 4, 2025
9454f24
Open extensibility API spec directly in fullscreen
mdipsan Nov 4, 2025
13e3d62
Fix extensibility API internal links
mdipsan Nov 4, 2025
9c998b1
Revert navbar search icon placement and clean up CSS after merge from…
mdipsan Nov 5, 2025
5590375
Revert favicon
mdipsan Nov 5, 2025
6ff2b33
Remove scripts for converting contract and reference links in markdow…
mdipsan Nov 5, 2025
783b9ce
Update style for Extensibility notes
mdipsan Nov 6, 2025
3d04b15
Fix broken link to BCM Fragment
mdipsan Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2

# Runs a single command using the runners shell
# Runs a single command using the runners shell
- name: install docfx
run: |
dotnet tool install -g docfx
Expand Down
1 change: 1 addition & 0 deletions RWSTemplate/styles/main.css
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

71 changes: 71 additions & 0 deletions articles/Extensibility/api/Extensibility-API.v1-fv.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Extensibility API Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

<link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css" />
<script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>

<style>
body {
display: flex;
flex-direction: column;
height: 100vh;
margin: 0;
padding-top: 55px; /* ensures content below fixed header */
}
.api-container {
flex: 1 0 0;
overflow: visible;
}
elements-api {
height: calc(100vh - 55px);
}

.header-bar {
position: fixed;
top: 0;
left: 0;
right: 0;
background-color: #006666;
color: white;
font-family: Arial, sans-serif;
padding: 10px 15px;
display: flex;
align-items: center;
box-shadow: 0 2px 3px rgba(0,0,0,.15);
z-index: 999;
}

.header-bar a {
color: white;
text-decoration: none;
font-size: 12px;
padding: 6px 12px;
border-radius: 5px;
background-color: rgba(255,255,255,0.15);
transition: background-color 0.2s;
}

.header-bar a:hover {
background-color: rgba(255,255,255,0.3);
}
</style>
</head>
<body>
<div class="header-bar">
<a href="Extensibility-API.v1.html">← Back to Documentation</a>
</div>

<elements-api id="docs" router="hash" layout="sidebar" hideTryIt="true"></elements-api>
<script>
(async () => {
const docs = document.getElementById('docs');
const text = await fetch('Extensibility-API.v1.json').then(res => res.text())
docs.apiDescriptionDocument = text;
})();
</script>
</body>
</html>
Loading