Hi team, To reduce manual work, we’re constantly implementing PIP 78: Generate Docs from Code Automatically [1].
Docs here refer to the following： - Connector configurations [2] - Client configurations [3] - Pulsar CLI tools [4] - Pulsar configurations [5] - pulsar-admin [6] # Question Currently, some of the docs above [7] are generated using brodocs [8]. We’re wondering if it makes sense to replace brodocs with docsify? # docsify benefits ## For users - Enjoy new features (eg. search, copy to clipboard, language highlighting, tabs, Disqus, etc.) - More clear and organized layout ## For doc maintainers - Simple and lightweight - No statically built HTML files. Instead, it smartly loads and parses .md files and displays them as a website. - Allow feature customization - Able to work with Google Analytics to track data # Demo We’ve created a demo here [9]. This demo is only for demonstration purposes, so we just add a few improvements. It can be iterated later. ~~~~~~~~~~~~~~~~~~~~ If docsify is better, we’ll use it for all the docs above to provide a consistent content experience. Feel free to check and comment, thank you! [1] https://lists.apache.org/thread/638q6kmq81z2qjmyhgkqzp00sllh4x0w [2] https://pulsar.apache.org/docs/next/io-connectors (Configurations for each connector) [3] https://pulsar.apache.org/docs/next/client-libraries-java (Configuration for each client. Here takes Java client as an example, it refers to configurations of client, producer, consumer, and reader) [4] https://pulsar.apache.org/docs/next/reference-cli-tools [5] https://pulsar.apache.org/docs/next/reference-configuration [6] https://pulsar.apache.org/tools/pulsar-admin/ [7] https://pulsar.apache.org/tools/ [8] https://github.com/Birdrock/brodocs [9] https://pulsar.apache.org/tools/pulsar-config/2.11.0-SNAPSHOT/#/ Yu, signormercurio, urfreespace
