2be4173812
- make bug reporting instructions more consistent - add DOCUMENTATION file - deduplicate Texinfo @cindex lines - fix typos and URLs - update obsolete references to Texinfo - standardize the spelling of HyperSpec
1.2 KiB
-
How/when to load/include docs of contribs?
Currently,
sb-manualloads all contribs to be able to query the definition docstrings. Each contrib directory has amanual.lispfile, which is part of thesb-manualcontrib (the files are symlinked).On the positive side, this does not load extra stuff until the user
requiressb-manual. However, then it loads all contribs.A finer grained approach may be preferable. For example, we could make the
manual.lispfile part of the contrib itself. Then people might complain about the overhead of loading/having the docstrings in the image.Alternatively, we could have
sb-bsd-sockets/manual.lispas a newsb-bsd-sockets-manualmodule. Eh. -
How to deal with repetitive package names?
For example,
sb-alienis:used bysb-manualso that the section docstrings need not fully qualify withsb-alien:a thousand times. In the generated Texinfo, this can be a tad confusing. In output formats with links (e.g. HTML from PAX), this is clearly preferable.Nicknames, maybe?
-
Improve section names
They are a soft interface: exported from
sb-manualand visible to the user via HTML anchors.