Skip to content

Commit 7d22f03

Browse files
author
James Calcaben
committed
Refactor TOC generation
The TOC has been refactored to use pre-set data files instead of calculating it during build time. This effectively cuts the build time in half and makes it easier to modify the table of contents.
1 parent b53bbcb commit 7d22f03

37 files changed

+3607
-110
lines changed

Diff for: _data/toc/admin-pattern-library.yml

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
label: Admin Pattern Library
2+
pages:
3+
- label: Introduction
4+
url: pattern-library/bk-pattern.html
5+
- label: Container
6+
children:
7+
8+
- label: Static Content Container
9+
url: pattern-library/containers/staticContentContainer/contentContainer.html
10+
11+
- label: Slide-out, Modals, and Overlays
12+
url: pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.html
13+
14+
- label: Tabs
15+
url: pattern-library/containers/tabs/tabs.html
16+
17+
- label: Controls
18+
children:
19+
20+
- label: Buttons
21+
url: pattern-library/controls/buttons/buttons.html
22+
23+
- label: Button Bar
24+
url: pattern-library/controls/button-bar/button-bar.html
25+
26+
- label: Expandable Sections
27+
versions: ["2.1","2.2"]
28+
url: pattern-library/controls/Expandable_Sections/expand-collapse.html
29+
30+
- label: View Controller
31+
versions: ["2.1","2.2"]
32+
url: pattern-library/controls/viewcontroller/viewcontroller.html
33+
34+
- label: Displaying and Dealing with Data
35+
children:
36+
37+
- label: Filters
38+
url: pattern-library/filters/data-table-filters/filtering.html
39+
40+
- label: Tile
41+
url: pattern-library/displaying-data/tile/tile.html
42+
43+
- label: Data Table
44+
url: pattern-library/displaying-data/datatable/datatable.html
45+
46+
- label: Tree
47+
url: pattern-library/displaying-data/tree/tree.html
48+
49+
- label: Feedback to User
50+
children:
51+
52+
- label: Progress Indicator
53+
url: pattern-library/feedbackToUser/progressIndicator/progressIndicator.html
54+
55+
- label: General
56+
children:
57+
58+
- label: Accessibility Guideline
59+
url: pattern-library/general/accessibilityguideline/accessibilityGuideline.html
60+
61+
- label: Getting User Input
62+
children:
63+
64+
- label: Form Elements
65+
url: pattern-library/getting-user-input/form_elements/form_elements.html
66+
67+
- label: Image Uploader
68+
url: pattern-library/getting-user-input/image_uploader/image_uploader.html
69+
70+
- label: Date and Time Selector
71+
url: pattern-library/getting-user-input/date_time_selector/date_time_selector.html
72+
73+
- label: Row Pattern (Table)
74+
url: pattern-library/getting-user-input/row_pattern/row_pattern.html
75+
76+
- label: Use Default Config
77+
url: pattern-library/getting-user-input/use_default_config/use_default_config.html
78+
79+
- label: Select From List
80+
url: pattern-library/getting-user-input/select_from_list/select_from_list.html
81+
82+
- label: Graphics
83+
children:
84+
85+
- label: Iconography
86+
url: pattern-library/graphics/iconography/iconography.html
87+
88+
- label: Navigation
89+
children:
90+
91+
- label: Links
92+
url: pattern-library/navigation/links/links.html
93+
94+
- label: Wizard
95+
url: pattern-library/navigation/wizard/wizard.html
96+
97+
- label: Staging Patterns
98+
versions: ["2.1","2.2"]
99+
children:
100+
101+
- label: Timeline Dashboard
102+
url: pattern-library/staging-patterns/TimelineDashboard/Timeline-Dashboard.html
103+
104+
- label: Scheduled Changes Module
105+
url: pattern-library/staging-patterns/ScheduledChangesModule/module.html
106+
107+
- label: Templates
108+
children:
109+
110+
- label: Address Form
111+
url: pattern-library/templates/address-form/address-form.html
112+
113+
- label: Sign In Form
114+
url: pattern-library/templates/sign-in-form/sign-in-form.html

Diff for: _data/toc/admin-style-guide.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
label: Admin Style Guide
2+
pages:
3+
- label: Admin Style Guide
4+
children:
5+
6+
- label: Introduction
7+
url: design-styleguide/bk-styleguide.html
8+
9+
- label: Design
10+
children:
11+
12+
- label: Color
13+
url: design-styleguide/color/color.html
14+
15+
- label: Iconography
16+
url: design-styleguide/iconography/iconography.html
17+
18+
- label: Page Grids
19+
url: design-styleguide/pagegrid/pagegrid.html
20+
21+
- label: Typography
22+
url: design-styleguide/typography/typography.html
23+
24+
- label: Writing and Content
25+
children:
26+
27+
- label: Voice and Tone
28+
url: design-styleguide/content-voide-tone/content-voice-tone.html
29+
30+
- label: Errors and Messages Writing
31+
url: design-styleguide/errors-and-messages/errors-and-messages.html
32+
33+
- label: Buttons and Links Usage
34+
url: design-styleguide/buttons-and-links-usage/buttons-and-links-usage.html
35+
36+
- label: Capitalization
37+
url: design-styleguide/capitalization/capitalization.html
38+
39+
- label: Headings and Organization
40+
url: design-styleguide/headings-and-organization/headings-and-organization.html
41+
42+
- label: Content Formats
43+
url: design-styleguide/content-formats/content-formats.html
44+
45+
- label: Number Formats
46+
url: design-styleguide/number-formats/number-formats.html

Diff for: _data/toc/architecture-guide.yml

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
label: Architecture Guide
2+
pages:
3+
- label: Introduction
4+
url: architecture/bk-architecture.html
5+
6+
- label: Architectural basics
7+
url: architecture/archi_perspectives/ABasics_intro.html
8+
children:
9+
10+
- label: Extensibility and modularity
11+
url: architecture/extensibility.html
12+
13+
- label: Ease of frontend customization
14+
url: architecture/frontend_custom_strategies.html
15+
16+
- label: Global features that support extensibility
17+
url: architecture/global_extensibility_features.html
18+
19+
- label: Security
20+
url: architecture/security_intro.html
21+
22+
- label: Storefront customization strategies
23+
url: architecture/storefront_customization.html
24+
25+
- label: Architectural diagrams
26+
url: architecture/archi_perspectives/arch_diagrams.html
27+
28+
- label: Technology stack
29+
url: architecture/tech-stack.html
30+
31+
- label: Architectural layers
32+
url: architecture/archi_perspectives/ALayers_intro.html
33+
children:
34+
35+
- label: Presentation layer
36+
url: architecture/archi_perspectives/present_layer.html
37+
38+
- label: Service layer
39+
url: architecture/archi_perspectives/service_layer.html
40+
41+
- label: Domain layer
42+
url: architecture/archi_perspectives/domain_layer.html
43+
44+
- label: Persistence layer
45+
url: architecture/archi_perspectives/persist_layer.html
46+
47+
- label: Components
48+
url: architecture/archi_perspectives/components/AComponents.html
49+
children:
50+
51+
- label: Module overview
52+
url: architecture/archi_perspectives/components/modules/mod_intro.html
53+
54+
- label: Modules and areas
55+
url: architecture/archi_perspectives/components/modules/mod_and_areas.html
56+
57+
- label: Module conventions
58+
url: architecture/archi_perspectives/components/modules/mod_conventions.html
59+
60+
- label: Module relationships
61+
url: architecture/archi_perspectives/components/modules/mod_relationships.html
62+
63+
- label: Module dependencies
64+
url: architecture/archi_perspectives/components/modules/mod_depend.html
65+
66+
- label: Module dependency types
67+
url: architecture/archi_perspectives/components/modules/mod_depend_types.html
68+
69+
- label: Magento Framework
70+
url: architecture/archi_perspectives/framework.html
71+
72+
- label: Third-party libraries
73+
url: architecture/archi_perspectives/third-party-libs.html

Diff for: _data/toc/b2b-developer-guide.yml

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
label: B2B Developer Guide
2+
pages:
3+
4+
- label: Introduction
5+
url: b2b/bk-b2b.html
6+
7+
- label: Integrate with B2B using REST
8+
url: b2b/integrations.html
9+
children:
10+
11+
- label: Company
12+
children:
13+
14+
- label: Integrate with the Company module
15+
url: b2b/company.html
16+
17+
- label: Manage company objects
18+
url: b2b/company-object.html
19+
20+
- label: Manage company users
21+
url: b2b/company-users.html
22+
23+
- label: Manage company roles
24+
url: b2b/roles.html
25+
26+
- label: Manage company structures
27+
url: b2b/company-structures.html
28+
29+
- label: Company credit
30+
children:
31+
32+
- label: Integrate with the CompanyCredit module
33+
url: b2b/company-credit.html
34+
35+
- label: Manage company credit
36+
url: b2b/credit-manage.html
37+
38+
- label: Shared Catalog
39+
children:
40+
41+
- label: Integrate with the SharedCatalog module
42+
url: b2b/shared-catalog.html
43+
44+
- label: Manage shared catalogs
45+
url: b2b/shared-cat-manage.html
46+
47+
- label: Assign categories and products
48+
url: b2b/shared-cat-product-assign.html
49+
50+
- label: Assign companies
51+
url: b2b/shared-cat-company.html
52+
53+
- label: Negotiable Quotes
54+
children:
55+
56+
- label: Integrate with the NegotiableQuote module
57+
url: b2b/negotiable-quote.html
58+
59+
- label: Manage negotiable quotes
60+
url: b2b/negotiable-manage.html
61+
62+
- label: Update a negotiable quote
63+
url: b2b/negotiable-update.html
64+
65+
- label: Negotiable quote checkout
66+
url: b2b/negotiable-checkout.html
67+
68+
- label: Develop B2B extensions
69+
url: b2b/extensions.html
70+

0 commit comments

Comments
 (0)