Skip to content
RustFox
Search limited to v1.0.8. Switch to the latest version for up-to-date results.

How to contribute

This content is for v1.0.8. Switch to the latest version for up-to-date documentation.

Two repositories. Code and product decisions go to RustFox. This site’s pages go to rustfox-docs. Architecture decision records stay in RustFox docs/adr/. This page does not copy them.

RustFox code

Section titled “RustFox code”

Repository: chinkan/RustFox. The project license is MIT. The steps below match CONTRIBUTING.md.

  • Bugs or feature requests. Open an issue.
  • Code or in-repo docs. Fork, branch from main, and keep the change focused.
  • Before you open the pull request. Run cargo fmt, cargo clippy -- -D warnings, and cargo test.
  • Pull request. Push and open it against main. Say what changed and why.
  • Screenshots. If you add a screenshot or GIF to the README or other docs, give the image descriptive alt text.

A decision that needs a record is an ADR in that docs/adr/ tree, in the RustFox repository. Do not add the ADR to this site.

rustfox-docs content

Section titled “rustfox-docs content”

Repository: chinkan/rustfox-docs. These pages are the English user guide (Getting started, How to use, Commands, Features, Providers, Troubleshooting, Changelog, and How to contribute).

  1. Fork and branch from main.
  2. Edit Markdown under src/content/docs/. The sidebar is the sidebar array in astro.config.mjs.
  3. Write in-page links with the /rustfox-docs prefix, for example [Setup](/rustfox-docs/setup/). Starlight 0.42 does not rewrite Markdown links.
  4. Run npm install if you need to, then npm run build. The build has to exit 0.
  5. Open a pull request against main. Edit this page on the published site opens the same repo.

Do not vendor the ADR tree into src/content/docs/. End-user pages explain the behavior in plain language. They do not link ADR bodies. Point readers to GUIDE.md, portal-access.md, or an in-site page such as Config, Providers, Commands, Portal, or Update. The public site is English-only. GUIDE and architecture notes stay in the RustFox repository. Keep them out of the sidebar.

Stack pins and the starlight-versions archive workflow are in NOTES.md. Do not bump those pins in a content-only change. After a RustFox GitHub Release tag, add or refresh src/content/docs/<tag>/ and src/content/versions/<tag>.json in a dedicated pull request.