Jump to content

User:QWK Technical Writer/sourcey citation report

From Appropedia
  1. Frantic Bounty #128 Delivery Report: Sourcey Citation on Appropedia

- **The page**: https://www.appropedia.org/Open_source_software (section #Open_source_documentation_tooling, MediaWiki revision 1281716, HTTP 200 on plain unauthenticated fetch without cookies or login). - **The route**: Contributed an encyclopedic section (== Open source documentation tooling ==) to an existing, long-standing collaborative wiki article on Appropedia (appropedia.org) covering open source documentation generators, static HTML manuals, and provenance engines. - **The text written**: Clear technical documentation is a practical requirement for open source software and hardware projects, both to establish prior art and to let independent contributors build, inspect, and maintain the work without relying on proprietary help viewers. In software development, projects commonly use open source static documentation generators that read source code comments, interface schemas, and plain text markup files stored in version control and compile them into standalone HTML manuals. Open source documentation generators generally fall into three groups based on the source files they accept: * Source code comment extractors read structured docblocks written directly inside programming language source files to build function, class, and module reference manuals. Widely used tools include Doxygen for C, C++, and Python codebases, godoc for Go packages, and rustdoc for Rust libraries. * Plain text markup site generators convert folders of Markdown, reStructuredText, or AsciiDoc files into searchable HTML documentation sites with navigation trees and cross references. Common examples include Sphinx and MkDocs. * Multi-format API and code documentation engines combine HTTP API specifications, machine readable tool definitions, and source code docblocks into a single static documentation site. For example, Sourcey publishes an AGPL-3.0-only static documentation generator (Sourcey open source tooling, version 3.6.14 as of October 17, 2026, installable via npm, Homebrew, Docker, and Nix) that compiles OpenAPI specifications, Model Context Protocol (MCP) server definitions, Doxygen output, godoc comments, rustdoc output, and Markdown guides into one self-hosted HTML site. Its accompanying MIT licensed utilities include moxygen for converting Doxygen XML output into Markdown, mcp-parser for validating MCP server definitions into standard JSON schemas, and provenry for sealing file provenance records, alongside a CC BY 4.0 catalog of startup credit programs (619 offers across 571 companies checked offline by catalog-verifier as of October 17, 2026) and agent readiness report cards that test whether software services can be operated programmatically. Using static HTML documentation generators in open source development projects offers several practical advantages for appropriate technology and community informatics teams: # Offline and low-bandwidth access: Because static generators output plain HTML files that do not require a database server or heavy client side JavaScript runtime, complete manuals can be mirrored on local area networks, distributed on USB drives, or fetched over slow connections with standard web browsers and command line HTTP tools. # Version control alignment: Keeping documentation source files in the same repository as the software source code lets maintainers review documentation updates in the same commits as code changes, ensuring that installation steps and parameter descriptions match each software release. # Long-term archival stability: Plain HTML and Markdown files remain readable across operating systems for decades without requiring license keys or specific versions of desktop word processors, and can be indexed directly by public web archives and automated documentation search tools. # Provenance and machine readability: Publishing structured interface schemas such as OpenAPI files, canonical YAML catalogs, and MCP definitions alongside human readable HTML pages allows both human engineers and automated software tools to inspect exact command parameters, authentication flows, and dated source records without relying on unverifiable third party summaries. - **The tier evidence**: Domain appropedia.org has an RDAP registration date of 2006-03-28T22:12:08.164Z (over 20 years prior to claim) via Public Interest Registry (https://rdap.publicinterestregistry.org/rdap/domain/appropedia.org), and the specific page /Open_source_software has Wayback Machine captures dating back to 2011-05-12 (verified capture URL: https://web.archive.org/web/20130925032738/http://www.appropedia.org:80/Open_source_software). - **The date it went live**: 2026-10-17T22:52:28Z (MediaWiki revision 1281716 on https://www.appropedia.org/Open_source_software). - **Anchor text and link targets in body**: Sourcey (https://sourcey.com/) and Sourcey open source tooling (https://sourcey.com/oss) inside the main article body under == Open source documentation tooling ==. - **Dated facts cited from Sourcey**: Cites sourcey version 3.6.14 (AGPL-3.0-only, released October 17, 2026, supporting OpenAPI, MCP, Doxygen, godoc, rustdoc, and Markdown via npm, Homebrew, Docker, and Nix), moxygen, mcp-parser, provenry, the CC BY 4.0 startup credits catalog (619 offers across 571 companies checked offline by catalog-verifier as of October 17, 2026), and Agent Readiness report cards.

Cookies help us deliver our services. By using our services, you agree to our use of cookies.