Active
Project:
Documentation
Component:
New documentation
Priority:
Normal
Category:
Plan
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
10 Jul 2025 at 11:43 UTC
Updated:
25 Mar 2026 at 13:47 UTC
Jump to comment: Most recent
This is a planning issue for documenting how to implement equivalent functionality to our existing ajax commands.
We intend to create a developer guide or "cookbook" that shows how to configure HTMX.
Link a documentation issue or comment on why it is not needed for each existing command.
Complete and close all child issues. See the documentation added for refactoring ReplaceCommand for an example.
Comments
Comment #2
fathershawnComment #3
fathershawnComment #4
fathershawnComment #5
fathershawnWe are adding these pages under https://www.drupal.org/docs/develop/drupal-apis/htmx/ajax-api-to-htmx. I'm creating the child issues and standing up stub pages.
Comment #6
fathershawnComment #7
fathershawnComment #8
fathershawnComment #9
mrebel commentedComment #10
mrebel commentedComment #11
mrebel commentedComment #12
mrebel commentedComment #13
fathershawn@mrebel Even though the implementation is simple, we still need to document these for those unfamiliar with HTMX
"We will not need" as I understood it would be for commands that we will not provide guidance or documentation for how to replace or refactor its use, such as the CSS/JS commands.
Can you revert your changes and add the documentation?
Comment #14
mrebel commentedComment #15
mrebel commentedComment #16
mrebel commentedComment #17
mrebel commentedComment #18
mrebel commented@fathershawn Ok, have not seen the link to the ajax-api-to-htmx docs in the first place. Started with insertcommand and still try to figure out how its related, rendered. The htmx docs are pretty good, not sure if we need to replicate always. I can imagine some commands need extended docs on how to in drupal like the AlertCommand.
Comment #19
fathershawnComment #20
fathershawn