Skip to content

Commit

Permalink
feat(daffio,dgeni): move guides around and docsgen guides and explana…
Browse files Browse the repository at this point in the history
…tions separately
  • Loading branch information
griest024 committed Jun 5, 2024
1 parent e55ce88 commit 300ecf5
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 7 deletions.
3 changes: 2 additions & 1 deletion apps/daffio/src/app/docs/docs-routing.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {

import { DaffRouteWithNamedViews } from '@daffodil/router';

import { DAFFIO_DOCS_GUIDE_DEFAULT } from './guides/guides-routing.module';
import { DaffioDocsHeaderContainer } from '../core/header/containers/docs-header/docs-header.component';
import { DaffioDocsSidebarContainer } from '../core/sidebar/containers/docs-sidebar/docs-sidebar.component';
import { DaffioRouterNamedViewsEnum } from '../named-views/models/named-views.enum';
Expand Down Expand Up @@ -35,7 +36,7 @@ export const docsRoutes: Routes = [
{
path: '',
pathMatch: 'full',
redirectTo: 'guides/getting-started/introduction',
redirectTo: `guides/${DAFFIO_DOCS_GUIDE_DEFAULT}`,
},
],
},
Expand Down
4 changes: 3 additions & 1 deletion apps/daffio/src/app/docs/guides/guides-routing.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import { DaffioRouterNamedViewsEnum } from '../../named-views/models/named-views
import { DaffioDocsPageComponent } from '../pages/docs-page/docs-page.component';
import { DocsResolver } from '../resolvers/docs-resolver.service';

export const DAFFIO_DOCS_GUIDE_DEFAULT = 'introduction/about';

export const docsRoutes: Routes = [
<DaffRouteWithNamedViews>{
path: '',
Expand All @@ -23,7 +25,7 @@ export const docsRoutes: Routes = [
{
path: '',
pathMatch: 'full',
redirectTo: 'getting-started/introduction',
redirectTo: DAFFIO_DOCS_GUIDE_DEFAULT,
},
{
path: '**',
Expand Down
File renamed without changes.
1 change: 0 additions & 1 deletion docs/getting-started/introduction.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/guides/introduction/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# About Daffodil
2 changes: 2 additions & 0 deletions docs/guides/introduction/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Getting Started

File renamed without changes.
3 changes: 2 additions & 1 deletion tools/dgeni/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ import { designExamplePackage } from './src/transforms/daffodil-design-examples-
import {
packageDocsPackage,
guideDocsPackage,
explanationDocsPackage,
} from './src/transforms/daffodil-guides-package';


rimraf('../../dist/docs/*', { glob: true }).then(() => {
new Dgeni([packageDocsPackage]).generate().catch(() => process.exit(1));
new Dgeni([guideDocsPackage]).generate().catch(() => process.exit(1));
new Dgeni([explanationDocsPackage]).generate().catch(() => process.exit(1));
new Dgeni([apiDocs]).generate().catch(() => process.exit(1));
new Dgeni([designExamplePackage]).generate().catch(() => process.exit(1));
});
27 changes: 24 additions & 3 deletions tools/dgeni/src/transforms/daffodil-guides-package/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,10 @@ export const packageDocsPackage = new Package('daffodil-package-docs', [base])
export const guideDocsPackage = new Package('daffodil-guide-docs', [base])
.processor(new GenerateGuideListProcessor({ outputFolder: 'guides' }))
.config((readFilesProcessor) => {
readFilesProcessor.basePath = DOCS_SOURCE_PATH;
readFilesProcessor.basePath = `${DOCS_SOURCE_PATH}/guides`;
readFilesProcessor.sourceFiles = [
{ include: [
// `${excludedDocsRegex}/**/*.md`,
`${excludedDocsRegex}/*.md`,
'**/*.md',
]},
];
})
Expand All @@ -88,3 +87,25 @@ export const guideDocsPackage = new Package('daffodil-guide-docs', [base])
outputPathTemplate: '${moduleFolder}.json',
});
});

export const explanationDocsPackage = new Package('daffodil-explanation-docs', [base])
.processor(new GenerateGuideListProcessor({ outputFolder: 'explanations' }))
.config((readFilesProcessor) => {
readFilesProcessor.basePath = `${DOCS_SOURCE_PATH}/explanations`;
readFilesProcessor.sourceFiles = [
{ include: [
'**/*.md',
]},
];
})
.config((computePathsProcessor) => {
const DOCS_SEGMENT = 'explanations';
computePathsProcessor.pathTemplates.push({
docTypes: ['guide'],
getPath: (doc) =>{
doc.moduleFolder = `${DOCS_SEGMENT}/${doc.id.replace(/\/docs/, '')}`;
return doc.moduleFolder;
},
outputPathTemplate: '${moduleFolder}.json',
});
});

0 comments on commit 300ecf5

Please sign in to comment.