Skip to content

Commit 697f03f

Browse files
authored
fix(scripts): add bundled readme to docs (#3336)
1 parent 8ca207c commit 697f03f

File tree

2 files changed

+3
-10
lines changed

2 files changed

+3
-10
lines changed

scripts/ci/codegen/pushToAlgoliaDoc.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ async function pushToAlgoliaDoc(): Promise<void> {
4545

4646
const pathToSpecs = toAbsolutePath(`${tempGitDir}/app_data/api/specs`);
4747
await run(`rm -rf ${pathToSpecs}/* || true`);
48+
await run(`cp ${toAbsolutePath('specs/bundled/README.md')} ${pathToSpecs}`);
4849
await run(`cp ${toAbsolutePath('specs/bundled/*.doc.yml')} ${pathToSpecs}`);
4950
await run(`cp ${toAbsolutePath('config/release.config.json')} ${pathToSpecs}`);
5051
await run(`cp ${toAbsolutePath('website/src/generated/*.json')} ${pathToSpecs}`);

specs/bundled/README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# Bundled specs
22

3-
**Please do not edit the files in this folder, they are generated and changes will be overwritten on next use**
3+
**Please do not edit the files in this folder, they are generated and changes will be overwritten by our scripts**
44

5-
Output folder of the specs located in `/specs/<CLIENT_NAME>/spec.yml`.
6-
7-
This folder hosts the bundled specs used to:
8-
9-
- Generate clients.
10-
- Generate documentation.
11-
- Share single readable spec file for a specific client.
12-
13-
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/introduction)
5+
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction)

0 commit comments

Comments
 (0)