4,686 questions
Advice
0
votes
0
replies
92
views
Best way to organize a technical reference repository for backend and DevOps
I’m a junior backend developer and I’ve created a technical reference repository with resources related to backend development, DevOps, and security: https://github.com/Rub3cK0r3/engineering-reference
...
Tooling
0
votes
1
replies
48
views
Xcode find module for class in Swift Developer Documentation
In the Xcode Developer Documentation, the type "FilePath" is listed under
Fundamentals > Foundation > Numbers, Data and Basic Values > URL > FileSystem
However, to use it, I need ...
- 9,262
Best practices
2
votes
3
replies
59
views
Is maintaining manual per-file and per-function change logs alongside Git considered a professional practice in 2026?
I’m working on a project where we already use modern version control practices:
Git with GitFlow branching
Pull requests with mandatory reviews
Conventional commit messages
CI-based checks
Despite ...
Advice
5
votes
1
replies
80
views
How to programmatically find pkgdown/altdoc documentation URLs for R packages?
I'm building a reference guide, R Functions for Categorical Data Analysis, https://friendly.github.io/psy6136/R-functions.html, that lists R functions for analysis and visualization, organized around ...
- 4,083
Advice
0
votes
2
replies
82
views
Are Kafka Heartbeat messages running on independent thread or are they linked to consumer poll and commit?
Is Kafka consumer heartbeat message same as consumer poll and commit? Or does it run on a separate thread and keeps sending heartbeat to Kafka broker as long as the consumer JVM is responding?
The ...
- 509
0
votes
0
answers
124
views
Wikipedia returns 403 when using sphinx linkcheck to check for broken links
We use sphinx linkcheck to make sure that our docs do not contain broken links, but Wikipedia has started returning a 403, assuming that our CI is a robot. Fair enough, it is a robot, so has anyone ...
- 1,288
Tooling
0
votes
3
replies
56
views
How to configure IntelliJ IDEA to include parameter and return types in auto-generated JavaDoc?
Is there a way to make Intellij add the types of the parameters and the return values in its auto-generated java documentation?
My desired documentation format would look like this:
/**
* Calculates ...
- 475
Tooling
1
vote
0
replies
39
views
Use a json body as point of reference for documentation
I am looking to move away from Excel spreadsheets. I want my json body to be the point of reference for mapping UI entry field, Database table.name.field, data exchange etc. Does this make sense?
- 21
Advice
0
votes
5
replies
53
views
Generating Interactive Documentation from Javascript Source Code
I’m working on an Electron project, and I can generate JSON for my code using JSDoc:
jsdoc -X > data.json
I want to use this JSON output to create a live, searchable documentation site similar to ...
- 56
0
votes
0
answers
44
views
How does the GJS documentation pipeline work with DevDocs?
I’ve noticed that GJS documentation uses DevDocs.
I’m trying to understand the documentation pipeline for GJS:
Does it read comments from the source code and generate documentation automatically?
Do ...
- 56
0
votes
0
answers
135
views
Sphinx sphinx-apidoc generated module titles are too long (full package path). How can I shorten them?
I am generating python API documentation using Sphinx and sphinx-apidoc with sphinx-rtd-theme
The problem is:
The page titles and ToC entries for modules/packages always show the full import path,
e....
- 179
0
votes
0
answers
32
views
Attach a TSDoc comment to a `export * as myModule from './my-module'`
Against ts_ls, the hover action on myModule above does not result in the documentation popping up. I've tried
/** Here is a documentation comment! */
export * as myModule from './my-module';
I've ...
1
vote
0
answers
83
views
Docsearch Typesense scraper only finds records on Docusaurus landing page
Problem
I’m using Docusaurus with Typesense and the docsearch-typesense-scraper to index my documentation site.
Everything runs fine — the sitemap is found, and the scraper produces records.
However, ...
- 11
0
votes
0
answers
102
views
How to show a single version dropdown per product in Docusaurus multi-product documentation?
I’m building documentation for multiple products on a single Docusaurus 3 website. Each product has its own versions, and I want users to be able to select a product first, then optionally select a ...
2
votes
1
answer
92
views
Why doesn’t Xcode show documentation for class initializers when creating an object in Swift?
I’m working with Swift and I’ve documented my class initializers using ///.
However, when I create an object with let obj = MyClass(...), the documentation does not appear when I Option-Click the ...
- 23