-
Notifications
You must be signed in to change notification settings - Fork 32
Add initial stub of agents file #1797
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # AI Assistant Guide for docs-builder | ||
|
|
||
| This file contains instructions and guidance for AIs when working with the docs-builder repository. | ||
|
|
||
| ## Repository overview | ||
|
|
||
| This is Elastic's distributed documentation tooling system built on .NET 9, consisting of: | ||
|
|
||
| - **docs-builder**: CLI tool for building single documentation sets | ||
| - **docs-assembler**: CLI tool for assembling multiple doc sets | ||
| - Written in C# and F# with extensive Markdown processing capabilities | ||
|
|
||
| ## Essential commands | ||
|
|
||
| ### Development | ||
| ```bash | ||
| # Build the project | ||
| dotnet build | ||
|
|
||
| # Simulates a full release -- run this to confirm the absence of build errors | ||
| dotnet run --project build -c release | ||
|
|
||
| # Runs all tests | ||
| dotnet test | ||
|
|
||
| # Run docs-builder locally | ||
| ./build.sh run -- serve | ||
|
|
||
| # Clean build artifacts | ||
| dotnet clean | ||
| ``` | ||
|
|
||
| ### Linting and Code Quality | ||
|
|
||
| ```bash | ||
| # Format code. Always run this when output contains formatting errors. | ||
| dotnet format | ||
|
|
||
| # Run specific test project | ||
| dotnet test tests/Elastic.Markdown.Tests/ | ||
|
|
||
| # Run tests with verbose output | ||
| dotnet test --logger "console;verbosity=detailed" | ||
| ``` | ||
|
|
||
| ## Key architecture Points | ||
|
|
||
| ### Main Projects | ||
|
|
||
| - `src/Elastic.Markdown/` - Core Markdown processing engine | ||
| - `src/tooling/docs-builder/` - Main CLI application | ||
| - `src/tooling/docs-assembler/` - Assembly tool | ||
| - `src/Elastic.Documentation.Site/` - Web rendering components | ||
|
|
||
| ### Testing Structure | ||
|
|
||
| - `tests/` - C# unit tests | ||
| - `tests/authoring/` - F# authoring tests | ||
| - `tests-integration/` - Integration tests | ||
|
|
||
| ### Configuration | ||
|
|
||
| - `config/` - YAML configuration files | ||
| - `Directory.Build.props` - MSBuild properties | ||
| - `Directory.Packages.props` - Centralized package management | ||
|
|
||
| ## Development guidelines | ||
|
|
||
| ### Adding New Features | ||
|
|
||
| 1. **Markdown Extensions**: Add to `src/Elastic.Markdown/Myst/` | ||
| 2. **CLI Commands**: Extend `src/tooling/docs-builder/Cli/` or `docs-assembler/Cli/` | ||
| 3. **Web Components**: Add to `src/Elastic.Documentation.Site/` | ||
| 4. **Configuration**: Modify `src/Elastic.Documentation.Configuration/` | ||
|
|
||
| ### Code style | ||
|
|
||
| - Follow existing C# and F# conventions in the codebase | ||
| - ... | ||
|
|
||
| ### Testing requirements | ||
|
|
||
| - Add unit tests for new functionality | ||
| - Use F# for authoring/documentation-specific tests | ||
| - ... | ||
|
|
||
| ### Common patterns | ||
|
|
||
| - ... | ||
|
|
||
| ## Documentation | ||
|
|
||
| The repository is self-documenting: | ||
|
|
||
| - `/docs/` contains comprehensive documentation | ||
|
|
||
| You MUST update the documentation when there are changes in the markdown syntax or rendering behaviour. | ||
|
|
||
| ## Useful file locations | ||
|
|
||
| - Entry points: `src/tooling/docs-builder/Program.cs`, `src/tooling/docs-assembler/Program.cs` | ||
| - Markdown processing: `src/Elastic.Markdown/Myst/` | ||
| - Web assets: `src/Elastic.Documentation.Site/Assets/` | ||
| - Configuration schemas: `src/Elastic.Documentation.Configuration/` | ||
| - Test helpers: `tests/Elastic.Markdown.Tests/TestHelpers.cs` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.