Add titles to every readme page + add test to validate it #304
Conversation
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
zastrowm
force-pushed
the
document_titles
branch
from
a9eff10 to
34530dc
Compare
As part of the site revamp CMS (astro.build) we need titles on each page
zastrowm
force-pushed
the
document_titles
branch
from
34530dc to
0064f94
Compare
zastrowm
force-pushed
the
document_titles
branch
from
0064f94 to
de19eab
Compare
Unshure
reviewed
Nov 3, 2025
| uses: actions/checkout@v4 | ||
| - name: Install dependencies | ||
| run: | | ||
| pip install . |
Member
There was a problem hiding this comment.
nit: Do we need to setup python first? https://github.com/strands-agents/sdk-python/blob/main/.github/workflows/test-lint.yml#L59
Comment on lines
+1
to
+3
| --- | ||
| title: Welcome | ||
| --- |
Member
There was a problem hiding this comment.
Does the readme need a frontmatter? Is this actually included in the docs?
I think we should only be checking for files under docs
| @@ -1,3 +1,6 @@ | |||
| --- | |||
| title: Multiagent | |||
Member
There was a problem hiding this comment.
Suggested change
| title: Multiagent | |
| title: Multi-agent |
| --- | ||
| title: Fireworks AI | ||
| --- | ||
| # FireworksAI |
Member
There was a problem hiding this comment.
Should there be a space here or in the above title?
| @@ -1,3 +1,6 @@ | |||
| --- | |||
| title: Amazon AgentCore Memory | |||
Member
There was a problem hiding this comment.
Does it matter if this doesnt match the below top-level header?
| @@ -1,3 +1,6 @@ | |||
| --- | |||
| title: Overview | |||
Member
There was a problem hiding this comment.
Can/should two pages have the same title?
Member
Author
|
I misunderstood what title is doing and need to re-think the approach here |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
I'm incrementally working towards getting our docs working with astro.build - to do so markdown files need a title front-matter.
Currently, mkdocs does this to derive the title:
However, astro.build desires the title to be in the front-matter; for compatibility with both, add the title from the nav and add it as a frontmatter meta property. Also added a test to enforce this for now
Type of Change
Motivation and Context
Incrementally let's docs work for both astro.build and mkdocs
Checklist
mkdocs serveAdditional Notes
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.