Skip to content

Commit 5e7ae15

Browse files
committed
Update README.md
1 parent fd2c404 commit 5e7ae15

File tree

1 file changed

+11
-26
lines changed

1 file changed

+11
-26
lines changed

README.md

Lines changed: 11 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,20 @@ Welcome to the official documentation for Strelka, an advanced tool for automate
1717

1818
## Overview
1919

20-
Strelka is designed for detailed malware analysis, providing robust scanning capabilities across various file types.
21-
The project's documentation is automatically generated and updated through GitHub Actions the latest changes in the `strelka` repository.
20+
Strelka is designed for large scale file analysis, providing robust scanning capabilities across various file types.
21+
The project's documentation is automatically generated and updated through GitHub Actions the latest changes in Target's [Strelka](https://github.com/target/strelka) repository.
2222

23-
## How Docs Work
23+
## Documentation Pipeline
2424

25-
Documentation for Strelka is automatically generated to ensure up-to-date information. Key sections include:
25+
`strelka-docs` builds and publishes new documents to the `gh-pages` branch.
2626

27-
- **Strelka Scanners**: Discusses the core analysis components.
27+
This branch is hosted on [GitHub](https://target.github.io/strelka-docs/).
28+
29+
## Documentation Update Schedule
30+
31+
Documentation for Strelka is automatically generated:
32+
- Daily @ 2 AM UTC
33+
- On Push to Branchs: [`gh-pages`, `main`]
2834

2935
## Running Docs Locally
3036

@@ -77,27 +83,6 @@ To set up and view the documentation locally, follow these steps:
7783

7884
Open your web browser and go to `http://127.0.0.1:8000/target/strelka/` to view the local documentation.
7985

80-
## Automated Pipeline
81-
82-
`strelka-docs` builds and publishes new documents to the `gh-pages` branch. This branch is hosted on [GitHub](https://target.github.io/strelka-docs/).
83-
84-
## Strelka Documentation Update Process
85-
86-
1. **Pull Request** (`strelka` repo)
87-
- A user submits a PR which is then reviewed for integration.
88-
89-
2. **Merge** (`strelka` repo)
90-
- The PR is approved and merged into the main branch.
91-
92-
3. **Build Trigger** (`strelka` repo)
93-
- The merge triggers the Vela pipeline, which builds Strelka and commits to the `strelka-docs` repo.
94-
95-
4. **Doc Build** (`strelka-docs` repo)
96-
- The `strelka-docs` pipeline generates documentation using the latest `strelka` repos.
97-
98-
5. **Publish** (`strelka-docs` repo)
99-
- Newly generated documentation is published and made available to users.
100-
10186
## Documentation Format
10287

10388
### Scanners

0 commit comments

Comments
 (0)