Skip to content

Documentation, take 2#267

Open
kaapstorm wants to merge 22 commits intomasterfrom
nh/docs_2
Open

Documentation, take 2#267
kaapstorm wants to merge 22 commits intomasterfrom
nh/docs_2

Conversation

@kaapstorm
Copy link
Contributor

Unpacks README.md and breaks out CONTRIBUTING.md, LICENSE and technical documentation under a new docs/ directory.

Removes duplication with Atlassian-hosted user documentation.

Tip

To make reviewing easier, click ... at the top right of a changed file, and choose "View file" to view it rendered.

🐡 🐠 🐟 Easiest to review commit-by-commit.

♻️ This PR is a reworking of PR #262

kaapstorm and others added 22 commits March 5, 2026 13:08
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…rmats.md

Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…-data.md

Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Content moved verbatim; no modifications.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Reorganize into clearer sections, update outdated references (Travis CI,
old pytest output), improve formatting of release process steps.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Clean up headings, update outdated references (Travis → GitHub Actions,
py.test → pytest), improve ODBC section organization.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add headings, cross-references, and environment composition explanation.
Remove verbose JSON output example to keep focus on library API usage.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Categorize built-in functions, complete the JSON syntax column for all
AST nodes, fix typos, add cross-references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Consolidate into a summary table, link to Confluence user docs for
detailed database connection strings and export instructions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add structure, link to Confluence for detailed query creation guidance,
add --dump-query tip for JSON format, add cross-references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add structure with clear headings, link to Confluence for detailed
usage, keep schema tables as developer reference, simplify prose.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Trim to quick reference since Confluence has detailed scheduling guide.
Add best practices section, fix cron expression.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Trim to essential reference, link to Confluence for full CLI guide.
Clean up formatting, fix SQLAlchemy typo.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace verbose installation/quick-start with concise version, link to
user documentation on Confluence, organize developer docs references,
use "CommCare Data Export Tool" naming.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Links to all developer-facing documentation and to the Confluence user
documentation for end users.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kaapstorm kaapstorm requested a review from millerdev March 6, 2026 12:58
@kaapstorm kaapstorm mentioned this pull request Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant