Skip to content

Commit 706b5a9

Browse files
adrianlyjakadrianlyjak
authored
Normalize line endings to LF and add .gitattributes (#436)
Add .gitattributes with `* text=auto eol=lf` to enforce Unix-style line endings and renormalize 11 files that had CRLF endings.
1 parent 1da57a1 commit 706b5a9

File tree

12 files changed

+917
-916
lines changed

12 files changed

+917
-916
lines changed

‎.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

‎.github/workflows/sync-docs.yml‎

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
1-
name: Sync Docs to Developer Hub
2-
3-
on:
4-
push:
5-
branches: [main]
6-
paths:
7-
- "docs/**"
8-
workflow_dispatch:
9-
10-
jobs:
11-
sync-docs:
12-
runs-on: ubuntu-latest
13-
steps:
14-
- name: Checkout source repo
15-
uses: actions/checkout@v4
16-
17-
- name: Install uv
18-
uses: astral-sh/setup-uv@v4
19-
20-
- name: Checkout docs repo
21-
uses: actions/checkout@v4
22-
with:
23-
repository: run-llama/developers
24-
token: ${{ secrets.DEVELOPER_HUB_TOKEN }}
25-
path: developer-hub
26-
27-
- name: Sync docs
28-
run: ./scripts/sync-docs-to-developer-hub.sh developer-hub
29-
30-
- name: Commit and push
31-
working-directory: developer-hub
32-
run: |
33-
git config user.name "github-actions[bot]"
34-
git config user.email "github-actions[bot]@users.noreply.github.com"
35-
36-
git add src/content/docs/python/llamaagents/ api-reference/python/workflows/
37-
38-
if git diff --staged --quiet; then
39-
echo "No docs changes to sync."
40-
exit 0
41-
fi
42-
43-
SOURCE_SHA="${GITHUB_SHA::8}"
44-
git commit -m "sync: workflows-py docs from run-llama/workflows-py@${SOURCE_SHA}"
45-
git push
1+
name: Sync Docs to Developer Hub
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "docs/**"
8+
workflow_dispatch:
9+
10+
jobs:
11+
sync-docs:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout source repo
15+
uses: actions/checkout@v4
16+
17+
- name: Install uv
18+
uses: astral-sh/setup-uv@v4
19+
20+
- name: Checkout docs repo
21+
uses: actions/checkout@v4
22+
with:
23+
repository: run-llama/developers
24+
token: ${{ secrets.DEVELOPER_HUB_TOKEN }}
25+
path: developer-hub
26+
27+
- name: Sync docs
28+
run: ./scripts/sync-docs-to-developer-hub.sh developer-hub
29+
30+
- name: Commit and push
31+
working-directory: developer-hub
32+
run: |
33+
git config user.name "github-actions[bot]"
34+
git config user.email "github-actions[bot]@users.noreply.github.com"
35+
36+
git add src/content/docs/python/llamaagents/ api-reference/python/workflows/
37+
38+
if git diff --staged --quiet; then
39+
echo "No docs changes to sync."
40+
exit 0
41+
fi
42+
43+
SOURCE_SHA="${GITHUB_SHA::8}"
44+
git commit -m "sync: workflows-py docs from run-llama/workflows-py@${SOURCE_SHA}"
45+
git push

‎docs.config.mjs‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
export default {
2-
section: "llama-index-workflows",
3-
label: "LlamaAgents",
4-
content: [
5-
{ src: "./docs/src/content/docs/llamaagents", dest: "python/llamaagents" },
6-
],
7-
sidebar: [
8-
{
9-
label: "LlamaAgents",
10-
content: {
11-
type: "autogenerate",
12-
directory: "python/llamaagents",
13-
collapsed: true,
14-
},
15-
append: [
16-
{
17-
label: "Agent Workflows Reference \u{1F517}",
18-
link: "/python/workflows-api-reference/",
19-
},
20-
],
21-
},
22-
],
23-
};
1+
export default {
2+
section: "llama-index-workflows",
3+
label: "LlamaAgents",
4+
content: [
5+
{ src: "./docs/src/content/docs/llamaagents", dest: "python/llamaagents" },
6+
],
7+
sidebar: [
8+
{
9+
label: "LlamaAgents",
10+
content: {
11+
type: "autogenerate",
12+
directory: "python/llamaagents",
13+
collapsed: true,
14+
},
15+
append: [
16+
{
17+
label: "Agent Workflows Reference \u{1F517}",
18+
link: "/python/workflows-api-reference/",
19+
},
20+
],
21+
},
22+
],
23+
};

‎docs/api_docs/docs/api_reference/index.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
# Workflows API reference
2-
3-
4-
For conceptual guides, patterns, and end-to-end examples, see the main [Agent Workflows documentation](/python/llamaagents/workflows/). This API reference focuses on signatures, parameters, and behavior of individual classes and functions.
5-
6-
## Installation
7-
8-
Install the core Workflows SDK from PyPI:
9-
10-
```bash
11-
pip install llama-index-workflows
12-
```
13-
14-
## What this reference covers
15-
16-
- **Workflow**: The event-driven orchestrator (`Workflow`) that defines and runs your application flows using typed steps. See [`Workflow`](./workflow/).
17-
- **Context**: Execution context and state management across steps and runs.
18-
- **Events**: Typed events that steps receive and emit (including `StartEvent`, `StopEvent`, and custom events).
19-
- **Decorators**: The `@step` decorator and related utilities for defining workflow steps.
20-
- **Handler**: `WorkflowHandler`, used to await results and stream intermediate events.
21-
- **Retry policy**: `RetryPolicy` configuration for per-step retry behavior.
22-
- **Errors**: Exception types raised by the runtime (validation, configuration, and runtime errors).
23-
- **Resource**: Resource and dependency injection primitives used by steps.
24-
25-
Use this reference together with the live examples on the main docs site, such as the [`Workflow` page on developers.llamaindex.ai](https://developers.llamaindex.ai/python/workflows-api-reference/workflow/), when you need both conceptual context and exact API details.
1+
# Workflows API reference
2+
3+
4+
For conceptual guides, patterns, and end-to-end examples, see the main [Agent Workflows documentation](/python/llamaagents/workflows/). This API reference focuses on signatures, parameters, and behavior of individual classes and functions.
5+
6+
## Installation
7+
8+
Install the core Workflows SDK from PyPI:
9+
10+
```bash
11+
pip install llama-index-workflows
12+
```
13+
14+
## What this reference covers
15+
16+
- **Workflow**: The event-driven orchestrator (`Workflow`) that defines and runs your application flows using typed steps. See [`Workflow`](./workflow/).
17+
- **Context**: Execution context and state management across steps and runs.
18+
- **Events**: Typed events that steps receive and emit (including `StartEvent`, `StopEvent`, and custom events).
19+
- **Decorators**: The `@step` decorator and related utilities for defining workflow steps.
20+
- **Handler**: `WorkflowHandler`, used to await results and stream intermediate events.
21+
- **Retry policy**: `RetryPolicy` configuration for per-step retry behavior.
22+
- **Errors**: Exception types raised by the runtime (validation, configuration, and runtime errors).
23+
- **Resource**: Resource and dependency injection primitives used by steps.
24+
25+
Use this reference together with the live examples on the main docs site, such as the [`Workflow` page on developers.llamaindex.ai](https://developers.llamaindex.ai/python/workflows-api-reference/workflow/), when you need both conceptual context and exact API details.

‎docs/src/components/Header.astro‎

Lines changed: 97 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,97 @@
1-
---
2-
import config from 'virtual:starlight/user-config';
3-
4-
import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
5-
import Search from 'virtual:starlight/components/Search';
6-
import SiteTitle from 'virtual:starlight/components/SiteTitle';
7-
import SocialIcons from 'virtual:starlight/components/SocialIcons';
8-
import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
9-
10-
/**
11-
* Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
12-
*/
13-
const shouldRenderSearch =
14-
config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
15-
---
16-
17-
<div class="header">
18-
<div class="title-wrapper sl-flex">
19-
<SiteTitle />
20-
</div>
21-
<div class="sl-flex print:hidden">
22-
{shouldRenderSearch && <Search />}
23-
</div>
24-
<div class="sl-hidden md:sl-flex print:hidden right-group">
25-
<div class="sl-flex">
26-
<a href="/typescript/framework/">TypeScript</a>
27-
</div>
28-
<div class="sl-flex social-icons">
29-
<SocialIcons />
30-
</div>
31-
<ThemeSelect />
32-
<LanguageSelect />
33-
</div>
34-
</div>
35-
36-
<style>
37-
@layer starlight.core {
38-
.header {
39-
display: flex;
40-
gap: var(--sl-nav-gap);
41-
justify-content: space-between;
42-
align-items: center;
43-
height: 100%;
44-
}
45-
46-
.title-wrapper {
47-
/* Prevent long titles overflowing and covering the search and menu buttons on narrow viewports. */
48-
overflow: clip;
49-
/* Avoid clipping focus ring around link inside title wrapper. */
50-
padding: 0.25rem;
51-
margin: -0.25rem;
52-
min-width: 0;
53-
}
54-
55-
.right-group,
56-
.social-icons {
57-
gap: 1rem;
58-
align-items: center;
59-
}
60-
.social-icons::after {
61-
content: '';
62-
height: 2rem;
63-
border-inline-end: 1px solid var(--sl-color-gray-5);
64-
}
65-
66-
@media (min-width: 50rem) {
67-
:global(:root[data-has-sidebar]) {
68-
--__sidebar-pad: calc(2 * var(--sl-nav-pad-x));
69-
}
70-
:global(:root:not([data-has-toc])) {
71-
--__toc-width: 0rem;
72-
}
73-
.header {
74-
--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
75-
--__main-column-fr: calc(
76-
(
77-
100% + var(--__sidebar-pad, 0rem) - var(--__toc-width, var(--sl-sidebar-width)) -
78-
(2 * var(--__toc-width, var(--sl-nav-pad-x))) - var(--sl-content-inline-start, 0rem) -
79-
var(--sl-content-width)
80-
) / 2
81-
);
82-
display: grid;
83-
grid-template-columns:
84-
/* 1 (site title): runs up until the main content column’s left edge or the width of the title, whichever is the largest */
85-
minmax(
86-
calc(var(--__sidebar-width) + max(0rem, var(--__main-column-fr) - var(--sl-nav-gap))),
87-
auto
88-
)
89-
/* 2 (search box): all free space that is available. */
90-
1fr
91-
/* 3 (right items): use the space that these need. */
92-
auto;
93-
align-content: center;
94-
}
95-
}
96-
}
97-
</style>
1+
---
2+
import config from 'virtual:starlight/user-config';
3+
4+
import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
5+
import Search from 'virtual:starlight/components/Search';
6+
import SiteTitle from 'virtual:starlight/components/SiteTitle';
7+
import SocialIcons from 'virtual:starlight/components/SocialIcons';
8+
import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
9+
10+
/**
11+
* Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
12+
*/
13+
const shouldRenderSearch =
14+
config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
15+
---
16+
17+
<div class="header">
18+
<div class="title-wrapper sl-flex">
19+
<SiteTitle />
20+
</div>
21+
<div class="sl-flex print:hidden">
22+
{shouldRenderSearch && <Search />}
23+
</div>
24+
<div class="sl-hidden md:sl-flex print:hidden right-group">
25+
<div class="sl-flex">
26+
<a href="/typescript/framework/">TypeScript</a>
27+
</div>
28+
<div class="sl-flex social-icons">
29+
<SocialIcons />
30+
</div>
31+
<ThemeSelect />
32+
<LanguageSelect />
33+
</div>
34+
</div>
35+
36+
<style>
37+
@layer starlight.core {
38+
.header {
39+
display: flex;
40+
gap: var(--sl-nav-gap);
41+
justify-content: space-between;
42+
align-items: center;
43+
height: 100%;
44+
}
45+
46+
.title-wrapper {
47+
/* Prevent long titles overflowing and covering the search and menu buttons on narrow viewports. */
48+
overflow: clip;
49+
/* Avoid clipping focus ring around link inside title wrapper. */
50+
padding: 0.25rem;
51+
margin: -0.25rem;
52+
min-width: 0;
53+
}
54+
55+
.right-group,
56+
.social-icons {
57+
gap: 1rem;
58+
align-items: center;
59+
}
60+
.social-icons::after {
61+
content: '';
62+
height: 2rem;
63+
border-inline-end: 1px solid var(--sl-color-gray-5);
64+
}
65+
66+
@media (min-width: 50rem) {
67+
:global(:root[data-has-sidebar]) {
68+
--__sidebar-pad: calc(2 * var(--sl-nav-pad-x));
69+
}
70+
:global(:root:not([data-has-toc])) {
71+
--__toc-width: 0rem;
72+
}
73+
.header {
74+
--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
75+
--__main-column-fr: calc(
76+
(
77+
100% + var(--__sidebar-pad, 0rem) - var(--__toc-width, var(--sl-sidebar-width)) -
78+
(2 * var(--__toc-width, var(--sl-nav-pad-x))) - var(--sl-content-inline-start, 0rem) -
79+
var(--sl-content-width)
80+
) / 2
81+
);
82+
display: grid;
83+
grid-template-columns:
84+
/* 1 (site title): runs up until the main content column’s left edge or the width of the title, whichever is the largest */
85+
minmax(
86+
calc(var(--__sidebar-width) + max(0rem, var(--__main-column-fr) - var(--sl-nav-gap))),
87+
auto
88+
)
89+
/* 2 (search box): all free space that is available. */
90+
1fr
91+
/* 3 (right items): use the space that these need. */
92+
auto;
93+
align-content: center;
94+
}
95+
}
96+
}
97+
</style>

0 commit comments

Comments
 (0)