Skip to content

Conversation

@adam-christian-software
Copy link
Contributor

@adam-christian-software adam-christian-software commented Nov 12, 2025

Context

This is a docs change which provides a Projects section in the top-level nav in the Docs. It handles this issue #2843 .

Currently, each tool just provides a link to the README in the Polaris-Tools repository. I'll be going through each tool and updating their README in Polaris-Tools and, then, bringing in user-facing docs which will clearly illustrate usage of these tools.

Checklist

  • [N/A] 🛡️ Don't disclose security issues! (contact [email protected])
  • [N/A] 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
  • [N/A] 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
  • [N/A] 💡 Added comments for complex logic
  • [N/A] 🧾 Updated CHANGELOG.md (if needed)
  • 📚 Updated documentation in site/content/in-dev/unreleased (if needed)

Docs Pictures

image image image image

Copy link
Member

@snazy snazy left a comment

Choose a reason for hiding this comment

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

This looks like a very good start to give the Polaris tools more awareness.

I'd just prefer to have the new tools/ folder directly under site/content, because the tools are not tied to Polaris releases, but have their own release cadence, if at all.

The Polaris tools could be added to the Documentation menu.

If you replace this line with this line

					<li>{{ .Pre }}<a class="dropdown-item" href="{{ .URL }}">{{ .Name }}</a> {{ .Post }}</li>

you can also add pre: "html code" and post: "html code" as described here.

@adam-christian-software
Copy link
Contributor Author

I'd just prefer to have the new tools/ folder directly under site/content, because the tools are not tied to Polaris releases, but have their own release cadence, if at all.

@snazy - You are completely right about the new section! I need to think a bit more about this because, from my understanding, we are trying to have each tool to be release independently. So, while having a top-level item for tools makes sense right now, it might not support us longer-term when we have Iceberg Catalog Migrator launching at a different cadence from the MCP Server.

Let me think about this and get back to you.

@snazy
Copy link
Member

snazy commented Nov 12, 2025

Not sure whether we have to solve that problem now.
Maybe it is an issue, maybe it's not.
I tend to think that it's not, because the code bases in polaris-tools are rather very focused on a very specific problem and I don't expect their functionality to change that drastically.
If one tool deserves a more feature-rich site at some point, we can always think about it for the particular tool.
There are many options, but no single option works for all.

For example the iceberg-catalog-migrator: it's rather a tool that is used once. I suspect nobody really cares about docs of old versions of that tool.

flyrain
flyrain previously approved these changes Nov 13, 2025
Copy link
Contributor

@flyrain flyrain left a comment

Choose a reason for hiding this comment

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

Thanks for the change, @adam-christian-software ! LGTM.

@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Nov 13, 2025
@adam-christian-software adam-christian-software changed the title docs(tools): Create the Tools Section in the Docs docs(tools): Create the Projects Section in the Docs Nov 13, 2025
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