46031df872
Merge 15 files into 3 consolidated docs and update all cross-references: - doc/NSS_IMPORT_NOTES.md: merges NSS_USERSPACE_ADAPTATION.md, NSS_PUBLIC_CORE_AUDIT.md, NSS_NAMESPACE_AUDIT.md - doc/TOOLBOX_PLAN.md: merges TUI_TOOLBOX_PLAN.md, NWCORE_INI_PLAN.md - doc/DIRECTORY_AND_ADMIN_PLAN.md: merges DIRECTORY_STACK_PLAN.md, NWADMIN_CLIENT_PLAN.md - doc/librarys/README.md: inlines 7 one-page stubs (nwtui, nwssl, nwflaim, nwxflaim, nwmatrixssl, nwlibsodium, nwowfat), deletes stub subdirs - REDESIGN.md: absorbs KERNEL_REFERENCE_AUDIT.md into the transport/SPX section; adds Table of Contents after the architecture status table - CLAUDE.md, AI.md, doc/README.md, doc/librarys/nwfs/README.md: all cross-references updated to new file names Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
# 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](overview/README) - historical upstream project overview notes.
|
|
- [Install](install/INSTALL) - installation notes and platform-specific setup.
|
|
- [FAQ and bugs](faq/FAQS) - old FAQs, bug notes, and translated question lists.
|
|
- [Features](features/) - feature-specific notes such as trustees, PIPE-FS, PPP,
|
|
file sharing, and NLS.
|
|
- [Quota](quota/README.md) - Linuxquota and NWQUOTA backend design.
|
|
- [History](history/) - old changelog, news, credits, and package metadata.
|
|
- [Packaging](packaging/) - distro packaging snippets kept as references.
|
|
- [Man pages](man/) - manual pages.
|
|
- [Assets](assets/) - images used by documentation or packaging.
|
|
- [Old](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_core` import classification, and namespace/storage import audit.
|
|
- `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.
|
|
- `HANDOFF_AUDIT.md` - current `nwconn`/`nwbind` magic-return audit,
|
|
provider vocabulary and NSS message-layer references.
|
|
- `TOOLBOX_PLAN.md` - coloured `nwtui`/`nwi18n` terminal UI, multi-call
|
|
`nwtoolbox`, curses-replacement plan, and shared `libnwcore` INI
|
|
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.
|
|
|
|
## 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.
|