Repository navigation
Our own llms.txt, built word for word from the docs, and every link checked - #232
Open
andrewbartels1 wants to merge 4 commits into
Open
andrewbartels1 wants to merge 4 commits into
andrewbartels1 wants to merge 4 commits into
Conversation
The drawing-pack plan keeps the new 'After the clean-up' scenario, now saying no tool is planned once the drawing pack is built.
…every link checked docs/llms.txt is generated from the mkdocs nav: each entry's title and summary are the page's heading and opening paragraph, copied word for word. A test fails when the file and the pages disagree, when it links outside this project, or when it holds HTML or hidden characters. Links within the project (pages, files, anchors, repository files) are checked on every test run; every link to another site after each docs deploy and weekly, with a report of every URL. Ten pages got a real opening paragraph; one moved link was updated. Queue item 19.
The !!python/name tags are replaced by null before parsing, so the file goes through safe_load and no custom loader is needed.
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Queue item 19. Our own
llms.txt, written fresh: nothing from #225 is used.What changed
docs/llms.txt, served at the docs site's root, is generated from the mkdocs nav (python -m solidworks_mcp.doc_links build). Each entry's title is the page's#heading and its summary the page's first paragraph, copied word for word; links in it are reduced to their text. Nothing in it is written by hand.blob/treelinks into this repo) in the README, the docs andllms.txtis checked on every test run: 402 links, none broken.python -m solidworks_mcp.doc_links check-external. It fails a dead link or a redirect to a different site, and writes a report of every URL. It runs after each docs deploy and weekly (a newlink-checkjob indeploy-docs.yml), not in the unit tests.Security review
54 entries, every URL on our docs site, no HTML or hidden characters; every line read by hand. The COM pitfalls page opened with an instruction to AI assistants; that sentence moved out of the opening so
llms.txtdescribes rather than instructs. The local-LLM page's opening carried a localhost address, moved to its second paragraph. Full notes:openspec/changes/own-llms-txt/design.md, decision 9.First online run
145 URLs; 143 visited and passing, 2 listed as not checked with their reasons.
andrewbartels1.github.io/SolidworksMCP-python/...URL forwards toandrewbartels1.com/SolidworksMCP-python/..., the custom domain on your GitHub Pages site. It's allowed as the same site; you may prefer to makeandrewbartels1.comthesite_url.console.anthropic.com/settings/keysmoved toplatform.claude.com; the link is updated.towardsdatascience.com(403) andwww.solidworks.com(times out) refuse scripts. The checker doesn't pretend to be a browser; both are listed as "not checked" in the report.Checks
mkdocs build --strictOK;llms.txtlands at the site root unchanged.openspec validate --all: 56 pass.No live SolidWorks demo: nothing here touches SolidWorks.