Connect Oxygen Feedback to published DITA OT docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- html, xml
- Domain
- documentation, web-dev
Research direction
Start by reviewing how the DITA OT documentation generates its HTML footer and compare the required integration with the linked Oxygen Feedback instructions and feedback_footer.xml example. Identify the footer entry point used for every generated page, then verify that the deployed documentation pages show a usable feedback form without disrupting existing content.
Written by the indexing model from the issue text.
Description
This is not a bug report.
The proposal is to add feedback forms at the end of each documentation page using the Oxygen Feedback cloud platform.
Something like this:
Feedback forms would allow users to leave suggestions on each page of the documentation web site.
One would need to perform these steps:
https://www.oxygenxml.com/doc/versions/4.1/ug-feedback-cloud/topics/ofb-installing-feeback-all-platforms.html
https://www.oxygenxml.com/demo/install_feedback_v2.html
and they would obtain a script similar to this one:
https://github.com/oxygenxml/blog/blob/master/publishing/webhelpBlogTemplate/html-fragments/feedback_footer.xml
which needs to be added to the footer of each HTML page generated from the DITA OT docs.
On the Oxygen Feedback platform we could give a long subscription to the DITA OT web site so that there is no cost involved.
Once the form is active and usable we could consider as a next step to also add an AI Assistant widget (enabled also through the Feedback platform) which would allow people to ask questions and would answer from the content of the DITA OT docs.
We already have something like this for the Oxygen user's guide:
I was reminded of this by @lief-erickson 's remarks about using LLM to answer userguide questions. Our Oxygen Feedback's AI-based chat (which we plan to officially release in Autumn) uses RAG retrieval augmentation based on project contents to answer questions.
- Dominant language
- XSLT
- Stars
- 64
- Forks
- 102
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from dita-ot/docs
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
-
coverage feature
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
Similar issues
-
documentation good first issue help wanted
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
zmo2s/agent-toolbox#23 ·
-
✨ enhancement needs-discussion
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
clawsweeper:needs-maintainer-review clawsweeper:no-new-fix-pr issue-rating: 🌊 off-meta tidepool P3
Difficulty 2/5 Half a day Newbie friendliness 62/100
openclaw/openclaw#168070 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
agent: ready area: submission priority: high type: docs
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
dkritarth/scopewatch#213 ·
Maintainers usually reply within 1 day
-
Broken link in RELEASE.mdPossibly taken @Jah-yee claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
sphinx-contrib/httpdomain#143 ·
Maintainers usually reply within 1 day