Skip to main content

Contribute to the Documentation

NuQloud documentation is maintained as Markdown and MDX in the public NuQloud-docs repository.

Make a useful change​

  1. Find the page under docs/.
  2. Write for the person performing the task.
  3. State prerequisites before steps.
  4. Separate core, provider-enabled, preview, and unfinished behavior.
  5. Add warnings before irreversible, public, or security-sensitive actions.
  6. Use sanitized screenshots with no tenant or identity data.
  7. Run npm run typecheck and npm run build.
  8. Submit the change through the repository's normal review process.

Writing style​

Prefer “Select Publish to QDN” over implementation names or controller routes. Define Qortal-specific terms on first use. Do not copy secrets, live pricing, private infrastructure, or speculative roadmap dates into public pages.

Repository: gitea.qortal.link/NuQloud-Public/NuQloud-docs

Edit in your browser​

Use Edit this page at the bottom of a documentation page, then sign in to Gitea with an account permitted to edit this repository. Edit the Markdown, review the diff, and save through the repository's normal review/delivery rules. No local Git installation is needed for that editing step.

The website is a static build. Saving a source edit does not change the live site until the build passes and the approved publishing process installs the new build/ output. There is currently no built-in live page editor in the docs site.

Keep guides current​

Check feature claims against current source and, separately, the provider's deployed interface. Record the source revision, review date, and any untested rollout limits. Preserve historical announcements as historical records rather than using them as the current feature list.

Capture actual product screens with fictional data. Verify that the image shows the action described by its filename, caption, and surrounding steps. Do not use generated mockups or a mobile-width browser image as evidence of native Android/iOS behavior. The repository's maintenance/ directory contains the source audit, publishing/editing assessment, and screenshot capture plan.