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_IMPORT_NOTES.md- NSS import notes: userspace adaptation boundary,public_coreimport classification, and namespace/storage import audit.NWFS_SALVAGE_COMPRESSION_TOOLS.md- salvage, stream, compression and tool roadmap.LOG_LEVEL_AUDIT.md- legacyXDPRINTF/INI debug-level audit and recommended1..5policy for new code.HANDOFF_AUDIT.md- currentnwconn/nwbindmagic-return audit, provider vocabulary and NSS message-layer references.TOOLBOX_PLAN.md- colourednwtui/nwi18nterminal UI, multi-callnwtoolbox, curses-replacement plan, and sharedlibnwcoreINI reader/writer plan.DIRECTORY_AND_ADMIN_PLAN.md- nwdirectory/libnwdirectory/libnwds layering, flatfile-first LDAP CTest plan, later FLAIM storage-backend swap, plus remote NCP-based administrator client roadmap and nwConsole architecture.../AGENTS.md- repository-specific coding-agent workflow rules.
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.