Skip to content

Commit d2758fd

Browse files
authored
Merge pull request #80 from serenity-js/docs/handbook-cleanup
docs(handbook): revised and extended the Serenity/JS Handbook
2 parents 545c749 + 7448baf commit d2758fd

File tree

58 files changed

+8067
-3416
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+8067
-3416
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
of complex software systems faster, more collaborative and easier to scale.
1414

1515
⭐️ Get started with Serenity/JS!
16-
- [Serenity/JS web testing tutorial](https://serenity-js.org/handbook/web-testing/your-first-web-scenario)
17-
- [Serenity/JS Handbook](https://serenity-js.org/handbook) and [Getting Started guides](https://serenity-js.org/handbook/getting-started/)
18-
- [API documentation](https://serenity-js.org/api/core)
19-
- [Serenity/JS Project Templates on GitHub](https://serenity-js.org/handbook/getting-started/project-templates/)
16+
- [Serenity/JS Tutorial](https://serenity-js.org/handbook/tutorials/)
17+
- [Serenity/JS Handbook](https://serenity-js.org/handbook/)
18+
- [API documentation](https://serenity-js.org/api/)
19+
- [Serenity/JS Project Templates on GitHub](https://serenity-js.org/handbook/project-templates/)
2020

2121
👋 Join the Serenity/JS Community!
2222
- Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im)
@@ -54,7 +54,7 @@ when you open the workspace, so you can start working on the Serenity/JS website
5454
To work on the Serenity/JS website locally, you'll need to:
5555
- [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) this repository to your GitHub account
5656
- [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) your fork to your machine
57-
- Make sure you have the have [Node.js](https://nodejs.org/) installed on your machine, as per the general [Serenity/JS installation instructions](https://serenity-js.org/handbook/getting-started/installation/#installing-nodejs)
57+
- Make sure you have [Node.js](https://nodejs.org/) installed on your machine, as per the general [Serenity/JS installation instructions](https://serenity-js.org/handbook/installation/)
5858
- Install the Node.js dependencies by running `npm ci` in the project root
5959
- Make sure you can build the Serenity/JS website on your machine by running `npm run build`
6060
- Start the local development server by running `npm start`

docusaurus.config.ts

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ const config: Config = {
7171
high-quality, business-focused test scenarios that interact with any interface of your system
7272
and produce comprehensive test reports that build trust between delivery teams and the business.
7373
`,
74+
banner: {
75+
text: 'New Playwright Test guide is out!',
76+
link: '/handbook/test-runners/playwright-test',
77+
}
7478
},
7579

7680
url: 'https://serenity-js.org',
@@ -103,6 +107,12 @@ const config: Config = {
103107
sidebarPath: './src/sidebars/handbook.ts',
104108
showLastUpdateAuthor: false,
105109
showLastUpdateTime: true,
110+
async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
111+
const sidebarItems = await defaultSidebarItemsGenerator(args);
112+
// DEBUG sidebar items
113+
// console.log({ sidebarItems })
114+
return sidebarItems.filter(item => ! item.id.endsWith('index'));
115+
},
106116
},
107117
blog: {
108118
...remarkOptions,
@@ -125,7 +135,6 @@ const config: Config = {
125135
],
126136

127137
themeConfig: {
128-
// Replace with your project's social card
129138
image: 'images/serenity-js-social-card.jpg', // open graph
130139
colorMode: {
131140
disableSwitch: false,
@@ -186,11 +195,11 @@ const config: Config = {
186195
title: 'Handbook',
187196
items: [
188197
{ label: 'Why Serenity/JS', to: '/handbook/' },
189-
{ label: 'Getting started', to: '/handbook/getting-started' },
190-
{ label: 'Web testing', to: '/handbook/web-testing' },
191-
{ label: 'API testing', to: '/handbook/api-testing' },
192-
{ label: 'Mobile testing', to: '/handbook/mobile-testing' },
198+
{ label: 'Tutorials', to: '/handbook/tutorials' },
193199
{ label: 'Core Design Patterns', to: '/handbook/design' },
200+
{ label: 'Web Testing', to: '/handbook/web-testing' },
201+
{ label: 'API Testing', to: '/handbook/api-testing' },
202+
{ label: 'Mobile Testing', to: '/handbook/mobile-testing' },
194203
{ label: 'Reporting', to: '/handbook/reporting' },
195204
{ label: 'Test runners', to: '/handbook/test-runners' },
196205
{ label: 'Integration', to: '/handbook/integration' },

0 commit comments

Comments
 (0)