You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,7 @@
3
3
**ALWAYS reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.**
4
4
5
5
Elastic's distributed documentation tooling system built on .NET 9, consisting of:
6
-
-**docs-builder**: CLI tool for building single documentation sets
7
-
-**docs-assembler**: CLI tool for assembling multiple doc sets
6
+
-**docs-builder**: CLI tool for building single documentation sets or assembling or assembling multiple documentation sets
8
7
- Written in C# and F# with extensive Markdown processing capabilities
9
8
10
9
## Working Effectively
@@ -77,10 +76,10 @@ dotnet run --project src/tooling/docs-builder -- serve
77
76
dotnet run --project src/tooling/docs-builder -- --help
78
77
79
78
# Get help for docs-assembler
80
-
dotnet run --project src/tooling/docs-assembler -- --help
79
+
dotnet run --project src/tooling/docs-builder -- assemble --help
Copy file name to clipboardExpand all lines: README.md
+3-7Lines changed: 3 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,9 @@
4
4
5
5
Distributed documentation tooling for a distributed company.
6
6
7
-
This repository is host to:
8
-
9
7
**`docs-builder`* command line tool to generate single doc-sets
10
-
**`docs-assembler`* command line tool to assemble all the doc sets.
11
8
12
-
Both get distributed[as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
9
+
Distributed[as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
13
10
14
11
The documentation files:
15
12
* are written in common Markdown with [Additional syntax extensions](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/) to produce a richer writing and reading experience.
@@ -23,7 +20,7 @@ This tool builds each repository in isolation and in addition produces a full ma
23
20
Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file.
24
21
For example, [Elasticsearch's links.json](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/elasticsearch/main/links.json) representing all linkable resources in the Elasticsearch repository.
25
22
26
-
The `docs-assembler` tool then assembles all the repositories in the [link-registry](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/link-index.json) using their last known good commit.
23
+
The `docs-builder assemble` command then assembles all the repositories in the [link-registry](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/link-index.json) using their last known good commit.
27
24
28
25
This allows us to:
29
26
@@ -58,8 +55,7 @@ Install [.NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0), then
58
55
After which the locally built binaries will be available at:
Our [Documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/locally) is the best place to learn how to start using the tool locally.
0 commit comments