Skip to content

Docs - added composite tab to docs build script #3709

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

Merged
merged 4 commits into from
May 4, 2025
Merged

Docs - added composite tab to docs build script #3709

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9f45c04
Added composite category in docs build script
nitzanyiz May 4, 2025
5fcc741
Added composite category to valid categories
nitzanyiz May 4, 2025
342324e
Refactor category validation to use consistent VALID_CATEGORIES constant
nitzanyiz May 4, 2025
23b2f3c
Revert "Refactor category validation to use consistent VALID_CATEGORI…
nitzanyiz May 4, 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
8 changes: 7 additions & 1 deletion scripts/docs/buildDocsCommon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const fs = require('fs');

const COMPONENTS_DOCS_DIR = './docs/components';
const SERVICES_DOCS_DIR = './docs/services';
const COMPOSITE_DOCS_DIR = './docs/composite';
const FOUNDATION_DOCS_DIR = './docs/foundation';

const VALID_COMPONENTS_CATEGORIES = [
Expand All @@ -27,7 +28,8 @@ const VALID_COMPONENTS_CATEGORIES = [
'infra',
// non components categories
'services',
'dev' // development category for components we don't want to render in our docs (used in test.api.json)
'dev', // development category for components we don't want to render in our docs (used in test.api.json),
'composite'
];

function buildDocs(apiFolders, componentsPreProcess) {
Expand Down Expand Up @@ -95,6 +97,10 @@ function processComponents(components) {

let dirPath;
switch (component.category) {
case 'composite': {
dirPath = `${COMPOSITE_DOCS_DIR}`;
break;
}
case 'services': {
dirPath = `${SERVICES_DOCS_DIR}`;
break;
Expand Down