Skip to content

chore: improves docs and add codeowners #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugomrdias merged 3 commits into from
Dec 15, 2025
Merged

chore: improves docs and add codeowners #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62827fd
chore: swap llm and page actions for new plugin @hugomrdias/docs
hugomrdias Dec 14, 2025
e7e01de
chore: add codeowners
hugomrdias Dec 14, 2025
a064372
Update .github/CODEOWNERS
hugomrdias Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
* @hugomrdias @rvagg

/docs/src/content/cookbooks @FilOzone/FIL-B
/docs/src/content/core-concepts @FilOzone/FIL-B
/docs/src/content/introduction @FilOzone/FIL-B
/docs/src/content/resources @FilOzone/FIL-B
/docs/src/content/developer-guides @FilOzone/FIL-B @hugomrdias @rvagg
6 changes: 2 additions & 4 deletions docs/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import starlight from '@astrojs/starlight'
import { llmsPlugin } from '@hugomrdias/docs/starlight-llms'
Copy link
Collaborator

@rvagg rvagg Dec 15, 2025

Choose a reason for hiding this comment

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

docs would be good in this, and why starlight-llms-txt isn't good enough?

Copy link
Member Author

@hugomrdias hugomrdias Dec 15, 2025

Choose a reason for hiding this comment

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

too slow and was just dumpimg all md content in one file, which is really bad for context management, and the spec doesnt really say that ...
and the other llm actions plugin was copying the markdown to the wrong path ...
so i merged them into my package and fixed the bugs

Copy link
Collaborator

@rvagg rvagg Dec 15, 2025

Choose a reason for hiding this comment

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

k, you should update your readme then to be more than nothing

import { docsPlugin } from '@hugomrdias/docs/starlight-typedoc'
import { defineConfig } from 'astro/config'
import mermaid from 'astro-mermaid'
Expand All @@ -7,8 +8,6 @@ import rehypeExternalLinks from 'rehype-external-links'
import starlightAutoSidebar from 'starlight-auto-sidebar'
import starlightChangelogs, { makeChangelogsSidebarLinks } from 'starlight-changelogs'
import starlightLinksValidator from 'starlight-links-validator'
import starlightLlmsTxt from 'starlight-llms-txt'
import starlightPageActions from 'starlight-page-actions'
import viteTsconfigPaths from 'vite-tsconfig-paths'

const site = 'https://docs.filecoin.cloud'
Expand Down Expand Up @@ -184,8 +183,7 @@ export default defineConfig({
plugin: ['typedoc-plugin-mdn-links'],
},
}),
starlightLlmsTxt(),
starlightPageActions(),
llmsPlugin(),
starlightAutoSidebar(),
starlightChangelogs(),
starlightLinksValidator(),
Expand Down
4 changes: 1 addition & 3 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
},
"devDependencies": {
"@astrojs/starlight": "^0.37.0",
"@hugomrdias/docs": "^0.1.6",
"@hugomrdias/docs": "^0.1.10",
"@types/react": "catalog:",
"@types/react-dom": "catalog:",
"astro": "^5.16.3",
Expand All @@ -27,8 +27,6 @@
"mermaid": "^11.12.2",
"rehype-external-links": "^3.0.0",
"sharp": "^0.34.4",
"starlight-llms-txt": "^0.6.0",
"starlight-page-actions": "^0.3.0",
"typedoc": "^0.28.15",
"typedoc-plugin-mdn-links": "^5.0.10",
"typedoc-plugin-missing-exports": "^4.1.2",
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/developer-guides/migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you are coming from an earlier version of any of the Synapse packages, you wi

<!-- Check out the [changelog](/changelog-sdk/version/0-37-0/) for more information. -->

The main entrypoint `@filoz/synapse-sdk` no longer export all the other modules, from this version onwards it will only export the `Synapse` class, constants and types. Check [reference](/reference/filoz/synapse-sdk/synapse/) for the current exports.
The main entrypoint `@filoz/synapse-sdk` no longer export all the other modules, from this version onwards it will only export the `Synapse` class, constants and types. Check [reference](/reference/filoz/synapse-sdk/synapse/toc/) for the current exports.
Copy link
Collaborator

@rvagg rvagg Dec 15, 2025

Choose a reason for hiding this comment

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

is /toc/ something new? this PR contains links to both https://docs.filecoin.cloud/reference/filoz/synapse-sdk/synapse/toc/ and https://docs.filecoin.cloud/reference/filoz/synapse-sdk/toc/ but neither of them exist today.

Copy link
Member Author

@hugomrdias hugomrdias Dec 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

yes before we were using index.md files but the "index.md" files are special because they end up being just /folder/ not folder/index/ so that was breaking a bunch of things in the llms and typescript plugins.


### Action: Change `import` statements

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/developer-guides/synapse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,5 +173,5 @@ try {
- [Getting Started](/getting-started/) - Installation and setup guide
- [Payment Operations Guide](/developer-guides/payments/payment-operations/) - Complete payment operations reference
- [Storage Operations Guide](/developer-guides/storage/storage-operations/) - Complete storage operations reference
- [API Reference](/reference/filoz/synapse-sdk/) - Full API documentation
- [API Reference](/reference/filoz/synapse-sdk/toc/) - Full API documentation
- [GitHub Repository](https://github.com/FilOzone/synapse-sdk) - Source code and examples
2 changes: 1 addition & 1 deletion docs/src/content/docs/getting-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Ready to dive deeper? Check out these comprehensive guides:

#### API Reference

For complete API documentation, see the [API Reference](/reference/filoz/synapse-sdk/) which covers:
For complete API documentation, see the [API Reference](/reference/filoz/synapse-sdk/toc/) which covers:

- All SDK classes and methods
- TypeScript interfaces and types
Expand Down