mars-nwe/doc/README.md

MARS-NWE documentation

This directory is the project documentation index. Keep the top-level doc/ directory small and put new material into topic subdirectories.

Topics

• Overview - historical upstream project overview notes.
• Install - installation notes and platform-specific setup.
• FAQ and bugs - old FAQs, bug notes, and translated question lists.
• Features - feature-specific notes such as trustees, PIPE-FS, PPP, file sharing, and NLS.
• Quota - Linuxquota and NWQUOTA backend design.
• History - old changelog, news, credits, and package metadata.
• Packaging - distro packaging snippets kept as references.
• Man pages - manual pages.
• Assets - images used by documentation or packaging.
• Old - legacy build/configuration references. The old BSD/Unix makefile is kept there as historical build reference.
• NSS_NAMESPACE_AUDIT.md - NSS namespace replacement/import audit.
• NSS_PUBLIC_CORE_AUDIT.md - NSS public_core import classification.
• NWFS_SALVAGE_COMPRESSION_TOOLS.md - salvage, stream, compression and tool roadmap.
• LOG_LEVEL_AUDIT.md - legacy XDPRINTF/INI debug-level audit and recommended 1..5 policy for new code.
• KERNEL_REFERENCE_AUDIT.md - Linux kernel reference imports, currently the disabled Linux 2.4.37.9 SPX implementation.
• HANDOFF_AUDIT.md - current nwconn/nwbind magic-return audit, provider vocabulary and NSS message-layer references.
• TUI_TOOLBOX_PLAN.md - coloured nwtui/nwi18n terminal UI, multi-call nwtoolbox and curses-replacement plan.
• NWCORE_INI_PLAN.md - shared libnwcore INI reader/writer plan for server config, setup/toolbox editing and optional translation catalogs.

Layout rule

New screenshots and reference captures should live next to the feature they document. For example, FILER or SYSCON screenshots for quota behavior belong under doc/quota/, not directly in doc/.

The old plain-text files are intentionally preserved, but moved into folders so future documentation can grow without making the top-level directory hard to read.