Swastika/docs/navigation relocalization#2764
Conversation
swstica
requested review from
leshy,
mustafab0,
paul-nechifor and
spomichter
as code owners
Greptile SummaryThis PR rewrites the Go2 navigation docs into a clearer workflow guide.
Confidence Score: 5/5This looks safe to merge.
Important Files Changed
Reviews (7): Last reviewed commit: "fix(docs): remove extra trailing newline..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| # Mintlify deploy does not fetch Git LFS; keep published docs assets as normal blobs. | ||
| docs/assets/dimensional-logo-master-transparent.png -filter -diff -merge | ||
| docs/assets/favicon.png -filter -diff -merge | ||
| docs/capabilities/navigation/assets/** -filter -diff -merge |
There was a problem hiding this comment.
reloc_and_nav_to.webp is now a published docs asset, but .webp is not covered by any binary or non-LFS attribute here. If Git's text=auto misclassifies this large WebP during checkout or archive creation, line-ending conversion can corrupt the image and the relocalization page renders a broken asset.
| docs/capabilities/navigation/assets/** -filter -diff -merge | |
| docs/capabilities/navigation/assets/** -filter -diff -merge | |
| *.webp -text binary |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #2764 +/- ##
=======================================
Coverage 71.91% 71.92%
=======================================
Files 979 979
Lines 87346 87346
Branches 7982 7982
=======================================
+ Hits 62819 62820 +1
Misses 22387 22387
+ Partials 2140 2139 -1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
|
||
| ## How it works | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
we have an autogenerator for graphs for blueprints, this ensures our docs are easily up to date with blueprint changes, and we have consistent visuals when rendering blueprints
code block above the diagram in my link should be folded via
<details>
<summary>diagram source</summary>
like others, since this code is not important for docs
|
|
||
| ```pikchr fold output=assets/go2nav_dataflow.svg | ||
| color = white | ||
| color = #1e293b |
There was a problem hiding this comment.
isn't mintlify also dark mode? this makes it look much worse, idk if there is a better solution, mintlify can't render transparent svg?
There was a problem hiding this comment.
it does render transparent svg, but mintlify theme is default to system/browser. so it was breaking for light theme. lmk if this works.
| docs/capabilities/memory/assets/.gitattributes -filter -diff -merge text | ||
| docs/capabilities/mapping/assets/** filter=lfs diff=lfs merge=lfs -text | ||
| # Mintlify deploy does not fetch Git LFS; keep site branding as normal blobs. | ||
| # Mintlify deploy does not fetch Git LFS; keep published docs assets as normal blobs. |
There was a problem hiding this comment.
the team concluded that we should not include blobs in github repo as it eventually significantly slows down all github checkouts. we have CI checks against this
There was a problem hiding this comment.
May need to store direct blobs somewhere becuase yes mintlify cant pull LFS. maybe seperate repo, or we just bite the bullet and put them in the main repo, i think theyre small anyway. Just want the docs site to look good and not reuqire a ton of maintance overhead
There was a problem hiding this comment.
If we were to include all the assets directly, it would quickly balloon the repo.
For example, in the current checkout we have 1510 text files, totaling 11MiB. But Just assets/5-all.png alone is 1.1 MiB, and some assets are larger.
I think one option would be to link directly to the GitHub hosted link, For example, docs/capabilities/navigation/assets/5-all.png would be https://media.githubusercontent.com/media/dimensionalOS/dimos/main/docs/capabilities/navigation/assets/5-all.png .
Another would be for us to host the assets somewhere ourselves.
If we do include the assets directly into Git, we'll have to carry those files forever!...
There was a problem hiding this comment.
main branch can have assets in LFS, i can create a new docs branch with git blobs and deploy mintlify docs on that new branch.
will remove the git blobs from this PR.
There was a problem hiding this comment.
@swstica I don't think that's a long term solution. That branch will have to be merged into main eventually, no? So it's just postponing things.
There was a problem hiding this comment.
@paul-nechifor agreed. will either host them somewhere as you suggested or move some assets to git blob.
There was a problem hiding this comment.
Are you getting this as well:
Pre-commit end-of-file-fixer fails when the generated SVG has multiple blank lines after </svg>. Co-authored-by: Cursor <cursoragent@cursor.com>
github-actions
Bot
added
the
ready-to-merge
4 participants
Problem
The navigation pages were thin and partly inaccurate (stale defaults, LFS-pointer images that Mintlify couldn't render, links were broken for mintlify.
Solution
capabilities/navigationdocs into a clearer, workflow-driven set