DeveloperStable

Writing Documentation

Voice, structure, and guidelines for docs contributions.

Audience: All usersRead: 5 minEdit on GitHub

Overview

Writing DocumentationVoice, structure, and guidelines for docs contributions.

This page is part of the Developer Portal portal. The portal covers everything needed to contribute to neuronscope — local dev setup, coding standards, unit/integration testing, release processes, and architecture decision records (adrs).

When to use it

Reach for documentation when the problem in front of you matches its scope: voice, structure, and guidelines for docs contributions.

  • You need a canonical answer that survives environment changes.
  • You want the behavior documented under a stability contract.
  • You are cross-referencing this material from another portal.

How it fits

Each portal in NeuronScope owns one axis of the library. Developer Portal owns contribute to the neuronscope platform. Sibling pages in the sidebar cover the adjacent surface area — start there if this page does not answer your question directly.

Next steps

Related