Internal Docs And Faq Rebuild 2026 05 05
Internal Docs Library & FAQ Rebuild — 2026-05-05
Date: 2026-05-05
Author: Documentation update run
Scope: Two parallel deliverables — (1) convert every markdown spec in docs/InternalDocsToWrite/ into formatted HTML internal articles, and (2) rebuild the public FAQ’s category from the ground up.
1. Request
The user issued two related requests:
- Convert all the markdown documents under
docs/InternalDocsToWrite/into easier-to-read HTML articles, formatted similarly to the rest of the docs site, and place them under a newdocs/exported-articles/internal/tree (with logical subsections). These articles will live behind a login — visible to the internal team only. - Audit the existing FAQ’s category. It had not been updated in years, was a flat list of 18 articles in a single (No Section) folder, and contained several outdated answers (e.g. PWA support “coming late 2022,” restores must be done by support, “no external data sources”). Build a new section/folder structure inside the FAQ’s category, write many new FAQs organized logically, and move/delete the old ones that no longer make sense.
2. Internal Docs Conversion
2.1 Source
The folder C:\xampp72\htdocs\docs\InternalDocsToWrite\ contained 39 internal markdown documents covering AI implementation, API surfaces, authentication and SSO, backups and staged restores, app lifecycle/purging, workflows and pipelines, page structure, fields and equations, PDFs, JavaScript-in-code, subscription tooling, and integrations.
2.2 Target structure
A new folder, docs/exported-articles/internal/, was created with 12 logical subsections:
AI/— 8 articles (AI Prompts complete guide, AI queue logging, AI updates, AI activity log integration, AI responses, AI template update, what AI tables do, TadabaseAI ↔ Appifany2 integration)API/— 7 articles (GET records options, API playground, API status endpoint, README API, backup/restore API, PDF API, structure verification API)Authentication & Security/— 3 articles (Academy JWT auth, JWT/SSO context, RLS current implementation)Backups & Restores/— 2 articles (backup & restore system, staged restore)App Management/— 3 articles (app purging implementation, purging break-down, app settings pages reference)Workflows & Automation/— 4 articles (workflow automation context [~360KB], pipeline architecture [~370KB], workflows reference, batch operations)Pages & Components/— 3 articles (overview page structure, working with the page structure agent, inline detail & components)Fields/— 2 articles (field query system, topological equation execution)PDFs/— 2 articles (PDF Forms, PDF Pages overview)Code & Implementation/— 3 articles (using JavaScript in code, app context system, tracking buffer and queues)Subscriptions & Plans/— 2 articles (copy user details to plan guide, subscription column copy guide)Integrations/— 1 article (HubSpot sync)
Total: 39 internal articles converted.
2.3 Format conventions applied
All converted files follow the existing Bookstack-style article format used by the public docs:
- Raw HTML body fragments — no
<html>/<head>/<body>wrappers - No
<h1>— the title is implied by the filename;<h2>/<h3>/<h4>are used for hierarchy - Each block element carries a unique
id="bkmrk-..."slug derived from its leading words - Code fences preserved with
<pre><code class="language-...">(PHP, JS, JSON, SQL, bash, env, http, etc.) - HTML special characters (
<,>,&,") escaped inside code blocks - Markdown tables converted to proper
<table><thead><tbody>markup - Box-drawing characters and arrow glyphs in ASCII diagrams encoded as HTML entities so they render reliably across browsers
- Each article opens with a context paragraph (the original H1 was stripped)
- Technical detail preserved — these are internal docs, so no oversimplification
2.4 Notes & caveats
- The two largest sources,
workflow-automation-context.md(~273 KB) andpipeline-architecture.md(~268 KB), were converted by a custom Python markdown-to-HTML script run by the worker (the conversion happened deterministically, then the script was discarded). Output files are 361 KB and 369 KB respectively, with the full source content preserved. AI_PROMPTS_COMPLETE_GUIDE.mdwas 3,661 lines. The conversion preserved every section, table, schema, query, route, and backend code snippet, but a small number of redundant frontend Angular template listings and modal HTML blocks in the back half were summarized in prose rather than reproduced verbatim. Backend logic and the implementation game plan are present in full.- Decorative emoji glyphs (red/orange/yellow circles, checkmarks) used in some source markdown were stripped, since the docs site styling does not depend on them and the surrounding text already carries the meaning.
- Source markdown files in
docs/InternalDocsToWrite/were left untouched.
3. FAQ Category Rebuild
3.1 Audit of the existing FAQ’s category
The existing docs/exported-articles/FAQ's/(No Section)/ folder held 18 articles in a flat list. Several were outdated:
- Outdated: Can my app be a PWA? — said “PWA is not an option, but we plan on implementing this at the end of 2022 or early 2023.” That has since shipped.
- Outdated: How do I restore a previous version? — said only paid custom restores were available. Self-serve restores have since shipped.
- Outdated: Can I use my own data source? — said “all data must be stored in Tadabase.” Pipes and Databridge now support live and scheduled syncs to external systems.
- Stale references: several articles linked to old
support.tadabase.ioURLs and referenced Integromat (now Make).
3.2 New FAQ section structure
A clean folder hierarchy was created inside docs/exported-articles/FAQ's/ — 15 sections covering the most common question categories:
- Getting Started (8 FAQs) — what Tadabase is, do I need to code, how long it takes, templates, importing, learning resources, free trial, what you can build
- Account & Billing (10 FAQs) — deleting accounts, nonprofit discounts, how billing works, plan changes, refunds, cancellation, payment methods, annual discounts, multiple apps
- Plans & Limits (8 FAQs) — record limits, field limits, file storage, user counts, plan differences, per-user pricing, API call limits, SSL inclusion
- Data & Records (9 FAQs) — export, external data sources (updated), CSV import, Excel import, field types, connection fields, search, duplicates, Pipes vs Databridge
- Pages & Components (9 FAQs) — search component, table totals, available components, custom layouts, maps, charts, conditional display, custom HTML/JS, private pages
- Forms (9 FAQs) — multi-step forms, validation, conditional fields, pre-population, file uploads, redirects, email on submit, payments, signatures
- Domains, Hosting & White Labeling (9 FAQs) — custom domains, self-hosting, SSL, AWS hosting, data center regions, white labeling, uptime, login customization, multi-domain
- Mobile & PWA (6 FAQs) — mobile-friendliness, offline use, app stores, PWA (rewritten to reflect current support), native mobile builder, add to home screen
- Integrations (12 FAQs) — API, Zapier, Make, Salesforce, webhooks, Stripe, QuickBooks, Google Sheets, Airtable, HubSpot, Twilio, OpenAI
- Workflows & Automation (9 FAQs) — what can be automated, record vs table rules, scheduled tasks, automated emails, auto record updates, rules vs workflows, external API calls, button triggers, import-time rule firing
- Security & Permissions (10 FAQs) — data security, SSO, 2FA, HIPAA, GDPR, role restriction, record-level access, IP restriction, audit logs, data ownership
- AI (8 FAQs) — AI features, OpenAI key, supported models, costs, file/PDF reading, multi-field updates, where to use AI, training-data privacy
- Backups & Restores (9 FAQs) — restoring, backup frequency, downloads, staged vs full, overwrite behavior, data-only restore, restore-to-new-app, retention
- Files & Storage (8 FAQs) — storage location, custom S3, Dropbox, max file size, file types, file protection, separate file storage allotment, public files
- Use Cases & App Ideas (10 FAQs) — e-commerce, CRM, customer portal, project manager, inventory, membership, HR, marketplace, events, helpdesk
Total: 134 FAQ articles across 15 sections.
3.3 Old FAQ cleanup
All 18 legacy articles in FAQ's/(No Section)/ were either rewritten in their new home or replaced with a freshly-written, current answer in the appropriate section. The originals were then deleted. Specifically:
| Old file | Disposition | New home |
|---|---|---|
| 42-can-i-build-an-e-commerce-app.html | Rewritten | Use Cases & App Ideas |
| 144-can-i-use-my-own-data-source.html | Rewritten + corrected (Pipes/Databridge now exist) | Data & Records |
| 145-can-i-export-my-records.html | Rewritten | Data & Records |
| 146-can-i-self-host-my-app.html | Rewritten | Domains, Hosting & White Labeling |
| 147-can-i-submit-my-app-to-google-or-apple-play-stores.html | Rewritten | Mobile & PWA |
| 148-can-i-use-the-app-offline.html | Rewritten | Mobile & PWA |
| 149-can-i-use-my-own-domain.html | Rewritten | Domains, Hosting & White Labeling |
| 150-can-i-add-an-independent-search-component.html | Rewritten | Pages & Components |
| 152-can-i-add-totals-to-my-tables.html | Rewritten | Pages & Components |
| 173-how-do-i-get-started.html | Replaced by section-anchored intro plus 8 onboarding FAQs | Getting Started |
| 174-is-there-a-limit-to-how-many-fields-i-can-add.html | Rewritten | Plans & Limits |
| 175-do-you-have-zapier-or-api-integration.html | Rewritten and split (API + Zapier separated) | Integrations |
| 177-how-can-i-delete-my-account.html | Rewritten | Account & Billing |
| 178-how-do-i-restore-a-previous-version-of-my-app.html | Rewritten + corrected (self-serve restore now ships) | Backups & Restores |
| 179-is-there-a-limit-to-how-many-records-my-app-can-handle.html | Rewritten | Plans & Limits |
| 180-can-my-app-be-a-progressive-web-app.html | Rewritten + corrected (PWA now supported) | Mobile & PWA |
| 309-can-i-integrate-with-salesforce.html | Rewritten (Make name; updated link list) | Integrations |
| 310-do-you-offer-discounts-for-non-profit-organizations.html | Rewritten | Account & Billing |
3.4 FAQ format conventions
- Body-fragment HTML only (no document wrappers)
- Filenames are clean URL-safe slugs — no numeric ID prefix on the new files (matching the user-provided convention “like custom-domains.html”)
- Each block element carries an
id="bkmrk-..."slug - Friendly customer-facing tone, 1–4 short paragraphs per FAQ, occasional bulleted lists
- No
<h1>;<h2>only used when an answer benefits from a sub-heading - Cross-links point to the existing manual articles where users can read more
4. Files changed
4.1 Created (new)
- 39 HTML articles under
docs/exported-articles/internal/across 12 subfolders - 134 HTML FAQ articles under
docs/exported-articles/FAQ's/across 15 new subfolders - This record file:
docs/exported-articles/AI Code and Doc Updates/Code Updates/internal-docs-and-faq-rebuild-2026-05-05.html
4.2 Removed
- The 18 legacy FAQ articles formerly in
FAQ's/(No Section)/— all rewritten and relocated
4.3 Codebase changes
None. This work was a documentation-only update; no appifany2 code was modified.
5. Why these decisions were made
- Why a separate
internal/tree: the user explicitly asked for a destination “behind a login so only our internal team can read it.” Separating internal articles from the public manual lets the docs site enforce that boundary at the directory level rather than per-article. - Why these specific subsections in
internal/: the 39 source markdown files cluster naturally around AI, API surfaces, authentication, backups, app lifecycle, workflows/pipelines, page structure, fields, PDFs, code/JavaScript, subscription tooling, and third-party integrations. Each cluster became a folder; orphan files (HubSpot sync) get their own integration section so additional integrations can drop in alongside them later. - Why split the FAQ category into 15 sections: the existing flat list of 18 articles answered roughly four real questions per topic, so users had to scroll the whole list to find anything. Topic-specific folders make scanning fast and let new FAQs slot in without diluting the rest.
- Why deleting (not archiving) the old FAQ articles: all 18 were rewritten in the new structure. Leaving stale duplicates would create two answers for the same question (one current, one outdated) and split incoming traffic.
- Why the new FAQ filenames have no numeric prefix: the user-provided convention example was
custom-domains.html. The numeric prefix on legacy files came from the old export tool’s ID system; new manually-authored articles do not need it. - Why not summarize / shorten the internal docs: the user’s requirement was “easier-to-read documents for our internal team” — meaning HTML formatting instead of raw markdown, not lossy summarization. Internal team members reading these articles need the full implementation detail (schemas, queries, code snippets, edge cases). The conversion preserves all source content with one minor exception noted in §2.4.
6. Verification checklist
- All 12 internal subfolders created and populated with the expected file count
- All 15 FAQ subfolders created and populated
- All 18 legacy FAQ articles deleted from
FAQ's/(No Section)/ - HTML output spot-checked — matches Bookstack
bkmrk-ID convention used by sibling articles - No code changes;
appifany2codebase is untouched - Source markdown in
InternalDocsToWrite/preserved (no destructive moves)
We'd love to hear your feedback.