sphinx-contrib / sphinx-contrib/confluencebuilder
Support for comments
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 352
- Forks
- 106
- PR merge metrics
- No merged PRs in 30d
Description
We love confluencebuilder so much! One of the things that we are trying to find a good solution for though is that when people outside our team make in-line comments on our published confluence pages, and then we publish new docs later that night, those comments get blown away.
The comments at the bottom of the page are fine, but in-line comments get lost. And that kind of makes sense.
I'm curious if you guys have a recommended solution or workaround for this? Or if this is something that could be thought about or investigated to find a good solution or workaround.
Thank you so much for your awesome tool. We use it every day.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are identified in the issue. Start by investigating how confluencebuilder publishes inline comments versus comments at the bottom of a page, then determine whether preservation or a documented workaround is expected. Done should be a maintainer-approved solution that prevents inline comments from being lost or clearly documents the supported workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100