docs: remove edit links, rename Console to App, clean CLI titles #220
Conversation
- Remove editOnGithub prop from DocsPage component to eliminate Edit on Github links - Update Console references to App in navigation and documentation content - Remove redundant Commands suffix from CLI page titles (API Key, Cloud, Project, etc.) - Update architecture.mdx Web Console to Web App - Maintain consistency with app.agentuity.com domain naming Co-Authored-By: grodrigues@agentuity.com <huijirohankei@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
WalkthroughThis update standardizes terminology across documentation and UI, changing references from "Console" to "App" or "Cloud App." It also removes the GitHub editing feature from the documentation page component and updates several CLI documentation titles for consistency. Minor formatting and metadata adjustments are included. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsPage
participant GitHub
User->>DocsPage: View documentation page
DocsPage--xGitHub: (No longer provides "Edit on GitHub" link)
DocsPage-->>User: Render documentation without GitHub edit option
Possibly related PRs
Suggested reviewers
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
npm error Exit handler never called! 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (1)
✨ Finishing Touches
🧪 Generate Unit Tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | c414601 | Commit Preview URL | Jul 09 2025, 08:18 PM |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
content/Introduction/architecture.mdx (1)
49-54: Duplicate list number – should be “5.”The previous item is already numbered
4.; reuse of4.here breaks the sequence.-4. **Web App** - A management interface offering: +5. **Web App** - A management interface offering:
🧹 Nitpick comments (15)
content/CLI/mcp.mdx (1)
2-3: Align description with new, slimmer titleSince the word “Commands” was dropped from the title, consider trimming it from the description for consistency and brevity.
-title: MCP -description: Commands for the Model Context Protocol (MCP) integration +title: MCP +description: Model Context Protocol (MCP) CLI referencecontent/CLI/project.mdx (1)
2-3: Keep front-matter description in sync with updated titleThe description still starts with “Commands …”. Dropping that matches the newly-shortened title and keeps docs concise.
-title: Project -description: Commands for creating and managing projects +title: Project +description: Create and manage projectscontent/CLI/cloud.mdx (1)
2-3: Minor wording tweak for consistencyWith the title no longer containing “Commands”, the description can be shortened too.
-title: Cloud -description: Commands for deploying and managing agents +title: Cloud +description: Deploy and manage agents on Agentuity Cloudcontent/CLI/version.mdx (1)
2-3: Drop redundant “Commands” in descriptionMirrors the pattern used in the other CLI docs after the title rename.
-title: Version -description: Commands for checking the version of the CLI +title: Version +description: Check and upgrade the Agentuity CLIcontent/CLI/auth.mdx (1)
2-3: Tighten description wordingShorter description reads cleaner next to the simplified title.
-title: Authentication -description: Commands for authenticating with Agentuity +title: Authentication +description: Authenticate with Agentuity Cloudcontent/CLI/agent.mdx (1)
2-3: Align the description with the simplified titleThe front-matter title dropped “Commands”, but the description still contains it, which is now slightly redundant.
-title: Agent -description: Commands for managing agents +title: Agent +description: Manage agents in your projectcontent/SDKs/javascript/llm.mdx (1)
30-30: Tighten wording and fix compound-sentence commaMinor grammar & style tweak; also removes double spaces.
-When any of the above SDKs are installed, the Agentuity Project will automatically detect it and route your requests to the AI Gateway. However, we will only route requests if you do not provide your own LLM API Key. By providing your own LLM API Key, the AI Gateway detection will be disabled and you will need to manually configure the LLM integration in the Agentuity App. +When any of the above SDKs are installed, the Agentuity project automatically detects them and routes your requests through the AI Gateway. However, this automatic routing is disabled if you supply your own LLM API key, and you must manually configure the LLM integration in the Agentuity App.content/CLI/dev.mdx (1)
2-3: Keep title & description consistentSince the title no longer includes “Commands”, consider trimming it from the description as well.
-title: Development -description: Commands for local development of agents using DevMode +title: Development +description: Local development of agents using DevModecontent/Cloud/api-keys.mdx (1)
8-8: Consider turning plain references to “Cloud App” into internal linksReaders will likely try to click “Cloud App”. Converting the two occurrences to an internal link keeps the doc UX consistent with the rest of the site.
-When you navigate to the API Keys page in the Cloud App (under Settings), +When you navigate to the API Keys page in the [Cloud App](/Cloud/) (under Settings), @@ -1. Navigate to the API Keys page in the Cloud App (under Settings) +1. Navigate to the API Keys page in the [Cloud App](/Cloud/) (under Settings)Also applies to: 22-22
content/Cloud/aigateway.mdx (1)
12-12: Good terminology update; stray zero-width char in height attribute is still lurkingLine 8 (unchanged) has
height={ 2382}with a U+200A hair-space before2382. The MDX parser tolerates it today, but it trips prettier/ESLint in CI and renders invalid HTML.-<ThemeImage baseName="aigateway" alt="AI Gateway" width={3680} height={ 2382} /> +<ThemeImage baseName="aigateway" alt="AI Gateway" width={3680} height={2382} />content/Introduction/getting-started.mdx (1)
80-83: Wording tweak for brand consistencyElsewhere we use “Agentuity Cloud App”. Consider the longer form to avoid ambiguity, or at least drop the second “App” to prevent repetition.
- title="Cloud App" - href="/Cloud/" - description="Learn about the Agentuity App capabilities." + title="Cloud App" + href="/Cloud/" + description="Learn about the Agentuity Cloud App capabilities."content/CLI/env.mdx (1)
123-123: Verify destination URL still accurate after wording changeThe link text now reads “App”, but the target slug remains
/Cloud/api-keys. If the Cloud UI also renamed the page (e.g./Cloud/appor/Cloud/environment), update the path accordingly to avoid 404s.-You can also manage your environment variables and secrets in the [App](/Cloud/api-keys). +You can also manage your environment variables and secrets in the [App](/Cloud/api-keys). # ↑ adjust the right-hand URL if the page movedcontent/Cloud/key-value-memory.mdx (1)
38-39: Minor: Keep numbered list markdown portableBecause you use explicit numbers (
1.then2.…) rather than1.for auto-increment, make sure future edits maintain ordering; otherwise markdown renderers that respect literal numbers will display duplicates.content/SDKs/python/llm.mdx (1)
30-30: Grammar fix – missing comma in compound sentenceAdd a comma before “and” to separate the two independent clauses.
-...will be disabled and you will need to manually configure... +...will be disabled, and you will need to manually configure...content/Cloud/vector-memory.mdx (1)
40-41: Alt text could be more descriptive for accessibility
alt="New Vector Memory Storage"doesn’t convey that this is a screenshot of the creation dialog/page. Something likealt="Create new vector instance dialog"would be clearer for screen-reader users.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (23)
app/(docs)/[[...slug]]/page.tsx(0 hunks)app/layout.config.tsx(1 hunks)content/CLI/agent.mdx(1 hunks)content/CLI/apikey.mdx(2 hunks)content/CLI/auth.mdx(1 hunks)content/CLI/cloud.mdx(1 hunks)content/CLI/dev.mdx(2 hunks)content/CLI/env.mdx(2 hunks)content/CLI/mcp.mdx(1 hunks)content/CLI/project.mdx(1 hunks)content/CLI/version.mdx(1 hunks)content/Cloud/aigateway.mdx(1 hunks)content/Cloud/api-keys.mdx(3 hunks)content/Cloud/index.mdx(1 hunks)content/Cloud/key-value-memory.mdx(2 hunks)content/Cloud/meta.json(1 hunks)content/Cloud/vector-memory.mdx(2 hunks)content/Introduction/architecture.mdx(1 hunks)content/Introduction/getting-started.mdx(1 hunks)content/SDKs/javascript/index.mdx(1 hunks)content/SDKs/javascript/llm.mdx(1 hunks)content/SDKs/python/index.mdx(1 hunks)content/SDKs/python/llm.mdx(1 hunks)
💤 Files with no reviewable changes (1)
- app/(docs)/[[...slug]]/page.tsx
🧰 Additional context used
🧠 Learnings (14)
📓 Common learnings
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agentuity.mdc:0-0
Timestamp: 2025-07-01T12:36:39.469Z
Learning: Applies to agent-docs/**/agentuity.yaml : Do not suggest edits to the Agentuity AI Configuration file (agentuity.yaml)
content/CLI/cloud.mdx (1)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Prefer using the `agentuity agent create` command to create a new Agent
content/CLI/agent.mdx (7)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
Learnt from: afterrburn
PR: agentuity/docs#195
File: agent-docs/src/agents/doc-processing/docs-processor.ts:7-15
Timestamp: 2025-06-18T04:07:57.583Z
Learning: In the agent-docs project, the ChunkMetadata type requires title and description fields to be mandatory strings rather than optional, indicating that the system ensures these fields are always populated during document processing.
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agentuity.mdc:0-0
Timestamp: 2025-07-01T12:36:39.469Z
Learning: Applies to agent-docs/**/agentuity.yaml : Do not suggest edits to the Agentuity AI Configuration file (agentuity.yaml)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : All code should be in Typescript format
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/sdk.mdc:0-0
Timestamp: 2025-07-01T12:36:46.237Z
Learning: Applies to agent-docs/src/agents/**/*.ts : Use TypeScript for better type safety and IDE support
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : The file should export a default function
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Prefer using the `agentuity agent create` command to create a new Agent
content/CLI/auth.mdx (1)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Prefer using the `agentuity agent create` command to create a new Agent
app/layout.config.tsx (3)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : All code should be in Typescript format
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/sdk.mdc:0-0
Timestamp: 2025-07-01T12:36:46.237Z
Learning: Applies to agent-docs/src/agents/**/*.ts : Use TypeScript for better type safety and IDE support
content/Cloud/api-keys.mdx (1)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Prefer using the `agentuity agent create` command to create a new Agent
content/Introduction/getting-started.mdx (1)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
content/Cloud/index.mdx (2)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agentuity.mdc:0-0
Timestamp: 2025-07-01T12:36:39.469Z
Learning: Applies to agent-docs/**/agentuity.yaml : Do not suggest edits to the Agentuity AI Configuration file (agentuity.yaml)
content/SDKs/javascript/llm.mdx (3)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer loading types from the node modules package `@agentuity/sdk` in the node_modules folder
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/sdk.mdc:0-0
Timestamp: 2025-07-01T12:36:46.237Z
Learning: Applies to agent-docs/src/agents/**/*.ts : Import types from `@agentuity/sdk`
content/SDKs/javascript/index.mdx (8)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer loading types from the node modules package `@agentuity/sdk` in the node_modules folder
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/sdk.mdc:0-0
Timestamp: 2025-07-01T12:36:46.237Z
Learning: Applies to agent-docs/src/agents/**/*.ts : Import types from `@agentuity/sdk`
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/sdk.mdc:0-0
Timestamp: 2025-07-01T12:36:46.237Z
Learning: Applies to agent-docs/src/agents/**/*.ts : Use TypeScript for better type safety and IDE support
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agentuity.mdc:0-0
Timestamp: 2025-07-01T12:36:39.469Z
Learning: Applies to agent-docs/**/agentuity.yaml : Do not suggest edits to the Agentuity AI Configuration file (agentuity.yaml)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : All code should be in Typescript format
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : The file should export a default function
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Prefer using the `agentuity agent create` command to create a new Agent
content/Introduction/architecture.mdx (2)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agentuity.mdc:0-0
Timestamp: 2025-07-01T12:36:39.469Z
Learning: Applies to agent-docs/**/agentuity.yaml : Do not suggest edits to the Agentuity AI Configuration file (agentuity.yaml)
content/SDKs/python/llm.mdx (1)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agentuity.mdc:0-0
Timestamp: 2025-07-01T12:36:39.469Z
Learning: Applies to agent-docs/**/agentuity.yaml : Do not suggest edits to the Agentuity AI Configuration file (agentuity.yaml)
content/SDKs/python/index.mdx (4)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agentuity.mdc:0-0
Timestamp: 2025-07-01T12:36:39.469Z
Learning: Applies to agent-docs/**/agentuity.yaml : Do not suggest edits to the Agentuity AI Configuration file (agentuity.yaml)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer loading types from the node modules package `@agentuity/sdk` in the node_modules folder
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Prefer using the `agentuity agent create` command to create a new Agent
content/Cloud/vector-memory.mdx (1)
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Prefer using the `agentuity agent create` command to create a new Agent
🧬 Code Graph Analysis (1)
app/layout.config.tsx (1)
components/NavButton.tsx (1)
NavButton(11-35)
🪛 LanguageTool
content/SDKs/javascript/llm.mdx
[uncategorized] ~30-~30: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he AI Gateway detection will be disabled and you will need to manually configure the...
(COMMA_COMPOUND_SENTENCE)
content/SDKs/python/llm.mdx
[uncategorized] ~30-~30: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he AI Gateway detection will be disabled and you will need to manually configure the...
(COMMA_COMPOUND_SENTENCE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Workers Builds: docs
🔇 Additional comments (11)
app/layout.config.tsx (1)
46-48: Text replacement looks goodLabel updated from “Console” ➜ “App”; no code or accessibility concerns introduced.
content/Cloud/meta.json (1)
2-2: Title change is fine but double-check downstream navigation slugsThe JSON nav renderer in this repo derives the sidebar slug from the
titlefield. Since only the display text changed (no new kebab-case field added), nothing should break—but please grep for/Cloud/Consolehard-links just in case a stale path slipped through.content/CLI/apikey.mdx (1)
2-2: Renamed title may break anchors produced by the MDX generatorSome pages/linkers auto-generate anchors from the front-matter
title. Anywhere that previously deep-linked with#api-key-commandswill now resolve to#api-key. A quick ripgrep for#api-key-commandswill surface any stale links.content/CLI/env.mdx (1)
2-2: Confirm navigation consistency for renamed titleChanging the front-matter title from “Environment Commands” to “Environment” is semantically fine, but please double-check that any sidebar / TOC entry deriving its label from this field will not collide with another page already titled simply “Environment”.
content/Cloud/key-value-memory.mdx (1)
21-22: Good terminology alignmentReference updated to “Cloud App” keeps wording consistent with the global rename.
content/Cloud/index.mdx (1)
3-7: LGTM – description & paragraph updatedDescription and opening paragraph correctly reflect “Cloud App”; no action needed.
content/SDKs/javascript/index.mdx (2)
41-44: Terminology update looks correct and consistent
References to “Console” were properly switched to “App,” aligning with branding elsewhere.
1-64: No stale “Agentuity Console” mentions detected
A recursive grep across thecontentdirectory returned zero matches, confirming all console references have been updated. No further action needed.content/SDKs/python/index.mdx (2)
40-44: Terminology update verified
The wording now matches the new “Agentuity App” naming. Good change.
1-58: No lingering “Agentuity Console” references found
Ranrg -n 'Agentuity Console' contentacross the Python docs—no matches detected. No further action required.content/Cloud/vector-memory.mdx (1)
18-19: Minor wording/style polishConsider code-style back-ticks for the menu path to visually separate UI labels:
-When you navigate to the Memory > Vector page in the Cloud App, you'll see … +When you navigate to the `Memory > Vector` page in the Cloud App, you'll see …[nitpick]
content/Cloud/vector-memory.mdx
Outdated
| When you navigate to the Memory > Vector page in the Cloud App, you'll see a table listing all your vector instances with the following information: | ||
|
|
There was a problem hiding this comment.
Breadcrumb refers to “Memory > Vector” while later bullets use “Services > Vector” – pick one UI path.
The first paragraph says “Memory > Vector page,” but the list on lines 37-38 points to “Services > Vector.” Unless the product genuinely has both menus, this will confuse readers. Align the paths (and update any screenshots/links) so the navigation cue is unambiguous.
🤖 Prompt for AI Agents
In content/Cloud/vector-memory.mdx around lines 18 to 19, the breadcrumb
navigation path "Memory > Vector" conflicts with the later bullet points
referencing "Services > Vector." Verify the correct UI navigation path and
update all instances in the document, including the first paragraph, bullet
points, and any screenshots or links, to consistently use the same path to avoid
reader confusion.
- Move content/Guides/ directory to content/Concepts/ - Update main navigation in content/meta.json - Update section title in Concepts/meta.json - Update all internal links from /Guides/ to /Concepts/ - Update card title in getting-started.mdx from 'Guides' to 'Concepts' Co-Authored-By: grodrigues@agentuity.com <huijirohankei@gmail.com>
- Add permanent redirect rule in next.config.mjs - Maps all /Guides/:path* URLs to /Concepts/:path* - Ensures existing links continue to work after rename - Tested redirect functionality locally Co-Authored-By: grodrigues@agentuity.com <huijirohankei@gmail.com>
| <DocsPage | ||
| toc={page.data.toc} | ||
| full={page.data.full} | ||
| editOnGithub={{ |
There was a problem hiding this comment.
i'm not sure i agree with this. @rblalock @mcongrove
There was a problem hiding this comment.
My reasoning for this one was that most of the stuff in our docs is dictated by internal implementation and not so much open to any open source contribution, I have no hard stance on this either. Felt like it would be best to point users to leave feedback rather than encourage modifications like its completely open source.
There was a problem hiding this comment.
Long term we want edit in Github IMO so we might as well keep it to encourage the open-ness. But I do like sending feedback - which can be on github too I think.
There was a problem hiding this comment.
Alright, so just gonna keep the button then. No problem with that. I think Discord is a better place to receive that feedback tho, since some people may use the docs as platform users but non technical and Github issues aren't the best for those people. @rblalock What you think about that?
app/layout.config.tsx
Outdated
| <div className="flex items-center gap-2 text-sm"> | ||
| <NavButton href="https://agentuity.com/blog" target="_blank" rel="noopener noreferrer">Blog</NavButton> | ||
| <NavButton href="https://app.agentuity.com" target="_blank" rel="noopener noreferrer">Console</NavButton> | ||
| <NavButton href="https://app.agentuity.com" target="_blank" rel="noopener noreferrer">App</NavButton> |
There was a problem hiding this comment.
My idea was just to keep it on track with the main website. If the main website calls it app and the docs call it console could be confusing.
There was a problem hiding this comment.
yeh its called App everywhere else including the url.
| "pages": [ | ||
| "Introduction", | ||
| "Guides", | ||
| "Concepts", |
There was a problem hiding this comment.
I'm also debating on this, initially I had it since the first 3 tabs of this are explanations of concepts, but the Communication, Data Handling and Streaming deal straight with the SDK usage.
There was a problem hiding this comment.
Is the confusion because "Guides" aren't tutorials so that's why you call them concepts?
There was a problem hiding this comment.
Is the confusion because "Guides" aren't tutorials so that's why you call them concepts?
Devin summarized very well my logic behind that, I really don't have a hard stance on it, it could be the ESL in me that sees it and feels weird about that.
There was a problem hiding this comment.
Devin suggestion of "Learn" seems more natural to me, but this is more about being pedantic about terminology at that point. I don't mind reverting this if better.
…feedback Co-Authored-By: grodrigues@agentuity.com <huijirohankei@gmail.com>
…tor' for consistency Co-Authored-By: grodrigues@agentuity.com <huijirohankei@gmail.com>
Response to Edit on Github Removal ConcernHi @jhaynie, I understand your concern about removing the "Edit on Github" functionality. Original rationale: This change was made based on Gabriel's specific feedback: "We have a 'Edit on Github' link on the docs, but most of the docs is formulated from internal systems, should we remove those? Feels like a suggestion for people to edit docs instead of giving feedback on the system, maybe replace it with feedback button." Gabriel's point was that since the documentation is generated from internal systems rather than being directly maintained in GitHub, the "Edit on Github" links might mislead users into thinking they should edit the docs directly rather than providing feedback through proper channels. Question for stakeholders: @rblalock @mcongrove - What are your thoughts on this? Should we:
I'm happy to adjust the implementation based on the team's decision. The functionality can easily be restored by adding back the |
Response to Guides → Concepts Rename ConcernHi @jhaynie, regarding the "Guides" → "Concepts" rename, this was also based on Gabriel's specific feedback. Original rationale: Gabriel stated: "Guides part is more of a Concepts than Guides." The reasoning was that the content in this section is more conceptual/educational rather than step-by-step procedural guides. Current content in this section:
These topics are indeed more conceptual explanations rather than traditional "how-to" guides. Question: What are your specific concerns with this terminology change? Would you prefer:
I've already implemented 301 redirects from Happy to adjust based on the team's preference! |
Additional Context on Guides → Concepts RenameThanks for the additional perspective @Huijiro! This is really helpful context. Gabriel's updated thinking: You make a good point about the mixed nature of the content:
Potential solutions to consider:
Current status: I've implemented 301 redirects so any decision can be made without breaking external links. The content can easily be:
What do you think would work best for users navigating the documentation? @jhaynie - does this additional context change your perspective on the rename? |
- rblalock supports keeping Edit on Github for 'open-ness' - restores editOnGithub prop to DocsPage component - addresses stakeholder consensus to maintain the functionality Co-Authored-By: grodrigues@agentuity.com <huijirohankei@gmail.com>
Response to rblalock's Question on Guides → ConceptsHi @rblalock! Great question about the reasoning behind the rename. The confusion stems from mixed content types: As @Huijiro (Gabriel) pointed out in his recent comment, the section contains both:
Original rationale: Gabriel initially requested the rename saying "Guides part is more of a Concepts than Guides" because traditional "guides" imply step-by-step tutorials, but much of this content is conceptual education. Current stakeholder positions:
Potential solutions:
What's your preference? The 301 redirects are in place so any decision can be implemented without breaking external links. |
Updated Stakeholder Positions on Guides → ConceptsThanks for the clarification @Huijiro! This helps clarify the current team positions: Current stakeholder alignment:
Current status: With Gabriel now expressing flexibility rather than a strong preference, the team has good options:
The 301 redirects are in place, so any decision can be implemented without breaking external links. Recommendation: Since this is now a team preference rather than a requirement, perhaps @rblalock and @jhaynie can weigh in on what feels most natural for the content structure? |
Final Status UpdateThanks @Huijiro for the clarification! Current status:
Technical implementation complete - all requested changes have been made and are working correctly. The remaining Guides→Concepts decision is now a team preference discussion rather than a technical requirement. Re: Discord vs GitHub feedback: That's a great point about non-technical users finding Discord more accessible than GitHub issues. @rblalock's input on the feedback channel strategy would be valuable. |
Gabriel's Updated Preference: "Learn" SectionThanks for the updated input @Huijiro! This is helpful for reaching a team decision. Updated stakeholder positions:
Current options for the team:
Technical note: Any of these can be implemented easily with the 301 redirects already in place. The change would involve:
Recommendation: Since Gabriel now prefers "Learn" and jhaynie originally disagreed with "Concepts", perhaps "Learn" could be a good compromise? @rblalock and @jhaynie - what are your thoughts on "Learn" vs the other options? |
|
Closing due to inactivity for more than 30 days. Configure here. |
Address GitHub Comments: Restore Edit on Github, Update Terminology, Fix Navigation Issues
Summary
This update addresses stakeholder feedback on PR #220 by implementing changes based on GitHub comments from jhaynie and rblalock. The key changes include:
These changes layer on top of the original comprehensive documentation improvements (44+ files) and address specific inconsistencies and stakeholder concerns identified during review.
Review & Testing Checklist for Human
Recommended test plan: Deploy to staging and systematically test: (1) Click "Edit on Github" links from various documentation pages to verify they work, (2) Navigate through Services > Vector flows, (3) Test old /Guides/ URLs redirect correctly, (4) Search codebase for any "Console" references that should be "Cloud App", (5) Review GitHub comments to finalize contested naming decisions.
Diagram
%%{ init : { "theme" : "default" }}%% graph TB subgraph "Stakeholder Feedback Resolution" EditRestore["app/(docs)/[[...slug]]/page.tsx"]:::major-edit NavButton["app/layout.config.tsx"]:::major-edit VectorNav["content/Cloud/vector-memory.mdx"]:::major-edit GHComments["GitHub Comment Discussions"]:::minor-edit end subgraph "Original PR Context" MetaJSON["content/meta.json (Guides→Concepts)"]:::context NextConfig["next.config.mjs (redirects)"]:::context ConceptsDir["content/Concepts/ directory"]:::context end subgraph "Stakeholder Positions" Gabriel["Gabriel: Mixed signals on changes"]:::context Jhaynie["jhaynie: Questioned 3 key changes"]:::context Rblalock["rblalock: Supported Edit on Github"]:::context end subgraph "Key Changes Made" EditFunctionality["Edit on Github: Removed → Restored"]:::major-edit TerminologyEvolution["Console → App → Cloud App"]:::major-edit NavConsistency["Memory > Vector → Services > Vector"]:::major-edit end Jhaynie --> EditRestore Rblalock --> EditRestore Jhaynie --> NavButton EditRestore --> EditFunctionality NavButton --> TerminologyEvolution VectorNav --> NavConsistency Gabriel --> GHComments subgraph Legend L1["Major Edit"]:::major-edit L2["Minor Edit"]:::minor-edit L3["Context/No Edit"]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#87CEEB classDef context fill:#FFFFFFNotes
Link to Devin run: https://app.devin.ai/sessions/18b005cb6831448da9c736cdcd40f954
Requested by: @Huijiro (grodrigues@agentuity.com)