Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Homogenize configuration docs #1973

Merged
merged 2 commits into from Nov 10, 2023

Conversation

Telroshan
Copy link
Collaborator

@Telroshan Telroshan commented Nov 7, 2023

The configuration docs between the api reference and the docs reference are inconsistent, between each other but also with htmx.js:

  • missing properties
  • incorrect defaults (disable-htmx instead of hx-disable)
  • 1 property was missing from htmx.config (ignoreTitle)
  • different descriptions
  • different order

This PR is an attempt to homogenize those 2 docs, consider it as a first step.

Please note I didn't reorder the lines nor did I make all descriptions match.
I did so that it would be easier to see the diff and review the changes, let me know @1cg @alexpetros if I should have went all the way and reordered everything around

@Telroshan Telroshan added documentation Improvements or additions to documentation ready for review Issues that are ready to be considered for merging labels Nov 7, 2023
src/htmx.js Outdated Show resolved Hide resolved
@alexpetros alexpetros merged commit 9c87f40 into bigskysoftware:master Nov 10, 2023
1 check passed
@Telroshan Telroshan deleted the Config-doc-homogenization branch November 10, 2023 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready for review Issues that are ready to be considered for merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants