Skip to content

Conversation

@EricGustin
Copy link
Member

@EricGustin EricGustin commented Feb 20, 2025

Some improvements to local hosting related docs. Most is visual improvements, but there are also some additions for clarification

- [`storage`](#storage-configuration) - Configures persistent storage
- [`telemetry`](#telemetry-configuration) - Configures telemetry and observability (OTEL)
- [`tools`](#tools-configuration) - Configures tools for AI models to use
<TableOfContents
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before:
image

After:
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably outside of this PR, but I think we should indicate that these rows are links somehow, not just a table.

description: "Arcade Engine Configuration Overview"
---

import { Tabs } from "nextra/components";
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before:
image

After:
image

# Engine Config Templates

**engine.yaml**
### engine.yaml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes it so that i can link to this from other pages

const handleRowClick = (firstColumnValue) => {
// Convert first column value to a valid ID format
const sectionId = firstColumnValue.toLowerCase().replace(/\s+/g, "");
const sectionId = firstColumnValue.toLowerCase().replace(/\s+/g, "-");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so that table of contents section names can have spaces and still be linked to a specific section on the page

@EricGustin EricGustin requested a review from a team February 20, 2025 23:06
- [`storage`](#storage-configuration) - Configures persistent storage
- [`telemetry`](#telemetry-configuration) - Configures telemetry and observability (OTEL)
- [`tools`](#tools-configuration) - Configures tools for AI models to use
<TableOfContents
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably outside of this PR, but I think we should indicate that these rows are links somehow, not just a table.

@EricGustin
Copy link
Member Author

EricGustin commented Feb 21, 2025

@wdawson the rows in the TableOfContents will react when hovered over. Do you think this is enough of an indication, or are you thinking of an underline + link highlight in addition?

For example check out the TOC on this page https://docs.arcade.dev/toolkits/development/github/github

@wdawson
Copy link
Contributor

wdawson commented Feb 21, 2025

@wdawson the rows in the TableOfContents will react when hovered over. Do you think this is enough of an indication, or are you thinking of an underline + link highlight in addition?

For example check out the TOC on this page https://docs.arcade.dev/toolkits/development/github/github

I think it's enough for now. But I'd like something else. Not sure what exactly.

@EricGustin EricGustin merged commit 55125df into main Feb 21, 2025
1 check passed
@EricGustin EricGustin deleted the ericgustin/local-run-through branch February 21, 2025 00:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants