Documentation fixes
Five documentation pages are live. The structure is right. The fixes below are in priority order. Work top to bottom.
Pages in scope
Applies to: all five documentation pages
The tables are currently plain text with line breaks, not HTML tables. They must be real tables.
All six pages including the index were inspected. None contains a single <table> element. Every table on the documentation is currently text.
Every table must use <table>, <thead>, <tbody>, <tr>, <th> and <td>. No tabs, no line breaks, no spaces used as columns.
Tables to convert, page by page
| Table | Columns |
|---|---|
| Supported Assets | Asset, Supported, Status |
| Supported Blockchain Networks | Asset, Network, Status |
| Table | Columns |
|---|---|
| Typical Execution Time | Batch Stage, Typical Time |
| Batch Status | Status, Description |
| Table | Columns |
|---|---|
| Typical Onboarding Timeline | Stage, Typical Time |
| Compliance Outcomes | Status, Description |
| Table | Columns |
|---|---|
| Which upload methods are supported | Upload Method, Supported |
| Batch Status | Status, Description |
| Table | Columns |
|---|---|
| Reconciliation Levels | Reconciliation Level, Description |
On /docs/settlement-and-execution-times/ the value "Seconds to a few minutes" is split across two lines. Put it in one cell.
On /docs/payout-reconciliation/ the row "Individual Transaction Verify the status of each recipient payout" has no visible column break. First cell is "Individual Transaction". Second cell is "Verify the status of each recipient payout".
Applies to: all five documentation pages
The body text contains hard line breaks in the middle of sentences, carried over from the Google Docs originals. Example from /docs/: "This documentation provides technical and operational information about the Smart Bulk / Payments platform".
Fix: open each page in the editor, switch to the code or text view, and delete the manual line breaks inside paragraphs. Paragraphs should wrap on their own. Do not remove the breaks between list items.
/docs/supported-assets-and-networks/
The page lists USDT as supported on ERC20, and the FAQ answers "Can I use Ethereum?" with "No". Both are correct, but because ERC20 runs on the Ethereum network, a reader or an AI assistant could interpret the two together as a contradiction. The fix is to be explicit about which is the network and which is the asset.
Say "Ether (ETH)" when you mean the asset and "Ethereum network" or "ERC20" when you mean the network. Avoid using "Ethereum" on its own anywhere on the page.
| Old | New |
|---|---|
| "No. Ethereum is currently not supported. But the system is prepared to support multiple currencies and ETH can be supported." | "The Ethereum network is supported for USDT payouts using the ERC20 standard. Ether (ETH) is not currently supported as a payout asset. Support for ETH is planned." |
Also update the Roadmap section
| Old | New |
|---|---|
| "Support for ETH is planned." | "Support for Ether (ETH) as a payout asset is planned. No date is committed." |
/docs/payout-reconciliation/
The current Proof of Payment section does not state how proof works. Replace the whole section with the text below.
New section, heading "Proof of Payment"
Smart Bulk Payments issues an individual blockchain transaction for every recipient in a payout batch. Recipients are not combined into shared transactions.
Each payout therefore produces its own transaction hash, which records:
- the amount sent
- the destination wallet address
- the originating address
- the time the transaction was confirmed on the blockchain
Because the transaction is recorded on a public blockchain, a recipient or an auditor can verify a payment independently on a public block explorer, without contacting Smart Bulk Payments and without relying on a platform dashboard.
Transaction hashes are available per payout instruction and can be exported alongside batch records.
Proof of payment at this level supports:
- internal audit requirements
- financial reporting
- resolving recipient queries about non-receipt
- operational investigations
Add these two FAQ entries to the same page
Question: Does every recipient receive their own blockchain transaction?
Answer: Yes. Smart Bulk Payments issues an individual blockchain transaction per recipient rather than aggregating multiple recipients into one transaction.
Question: How can a recipient verify they were paid?
Answer: Each payout has its own transaction hash. The recipient can enter that hash into a public block explorer for the relevant network and confirm the amount, the destination address and the confirmation time without contacting Smart Bulk Payments.
/docs/how-to-upload-a-payout-batch/
The section "What information is required in a payout batch" currently lists six generic categories and then says the exact specification is provided during onboarding. Replace it with the real field list.
This needs the actual specification from the product team. Ask for the exact CSV column names, whether each is required or optional, the accepted format for each, and the literal validation error messages the platform returns. Publish those verbatim.
Table to build once the specification is supplied
| Column name | Required | Format | Notes |
|---|---|---|---|
| To be populated from product team specification | |||
Publish the exact column headers as they appear in the CSV template, not descriptions of them. Publish the literal error strings the platform returns, not paraphrases.
/docs/settlement-and-execution-times/ and /docs/how-to-upload-a-payout-batch/
Both pages carry a Batch Status table and a Batch Processing Workflow, with different wording for the same statuses. One example: "Validating" is described as "File structure and recipient data are being verified" on one page and "Data integrity and required information are being verified" on the other.
Fix:
- Keep the Batch Status table and the Batch Processing Workflow on /docs/how-to-upload-a-payout-batch/ only.
- On /docs/settlement-and-execution-times/, delete both and replace with a single line: "For the full list of batch statuses and the processing workflow, see How to Upload a Payout Batch." Link the page title.
- Make sure the stage names in the workflow match the status names in the table exactly.
Applies to: all five documentation pages
Every page currently lists itself in its own Related Documentation block.
Fix: on each page, delete the link to that same page from its Related Documentation list. Each page should link to the other four only.
/docs/
Delete the entire "Coming Soon" section listing API Documentation, Error and Exception Reference, Reporting and Statements, Dashboard Guide, User Roles and Permissions, Security, and Frequently Asked Questions.
It advertises missing pages, and it lists "Frequently Asked Questions" as unpublished when every documentation page already has an FAQ. Add the pages to the index when they go live.
/docs/
- Remove the literal "URL" labels and the plain-text paths under each documentation entry. Link the heading of each entry instead.
- Add a link to the pricing page under a new heading "Pricing": link text "Bulk payout fees and pricing model", target https://smartbulkpayments.com/pricing/
/docs/supported-assets-and-networks/
| Old | New |
|---|---|
| "Mixed assets within the same batch may be subject to platform limitations depending on the payout configuration." | Needs a yes or no from the product team. Ask whether a single batch can contain more than one asset. Publish the direct answer, and if there are conditions, state them. |
Applies to: all five documentation pages
Add a byline under the H1 on each page in this format:
Published: [date] · Last updated: [date] · Author: [name, role] · Reviewed by: [name, role]
Use real names and real roles. Do not use "admin".
Applies to: all five documentation pages
Every documentation page currently outputs one JSON-LD block containing only BreadcrumbList, Organization, WebPage and WebSite. There is no FAQPage schema and no TechArticle schema on any page, including the index.
Every documentation page has a visible FAQ block, so the FAQ content is not machine readable at present.
Fix:
- Add FAQPage schema to each of the five documentation pages, covering every question and answer in that page's FAQ block.
- Add TechArticle schema to each of the five documentation pages.
- The questions and answers in the JSON must match the visible text on the page word for word.
If All in One SEO is in use, this is set per page under the AIOSEO Schema tab: add the FAQ schema type and the Article or TechArticle type to each documentation page. If AIOSEO cannot output TechArticle, add the JSON-LD manually in the page template.
Do not add FAQ schema for questions that are not visible on the page. The schema must describe what a visitor can actually see.
Cloudflare and plugin cache
Cloudflare > Caching > Purge Everything. If a WordPress caching plugin is active, clear its cache too. Changes will not appear on the live pages until the cache is cleared.
Confirm the fixes are live
- Open each of the five documentation pages with a unique query string added to force a fresh copy, for example https://smartbulkpayments.com/docs/payout-reconciliation/?x=1 and change the number each time.
- Press Ctrl+U to view source. Search for "<table" and confirm every table on the page is a real HTML table.
- On /docs/supported-assets-and-networks/ search the visible text for "Ethereum" and confirm it never appears on its own, only as "Ethereum network" or alongside ERC20, and that "Ether (ETH)" is used for the asset.
- On /docs/payout-reconciliation/ search for "transaction hash" and confirm the new Proof of Payment section is live.
- On each page, confirm the Related Documentation block does not link to the page you are on.
- On /docs/ confirm the Coming Soon block is gone and the pricing link is present.
- In the source, search for "FAQPage" and "TechArticle" and confirm both now appear on every documentation page.
- Run each page through the Google Rich Results Test at https://search.google.com/test/rich-results and confirm the FAQ items are detected with no errors.
Checklist
- All tables on all five pages converted to real HTML tables.
- Split values fixed on the settlement and reconciliation tables.
- Pasted line breaks removed from body text on all five pages.
- Ethereum network and Ether (ETH) wording separated on the assets page.
- Proof of Payment section rewritten on the reconciliation page, two FAQ entries added.
- CSV field specification requested from the product team and published.
- Batch status and workflow kept on the upload page only, settlement page links to it.
- Self-links removed from all five Related Documentation blocks.
- Coming Soon block removed from the docs index.
- URL labels removed from the index, headings linked, pricing link added.
- Mixed-asset answer confirmed with the product team and published.
- Author and reviewer byline added to all five pages.
- FAQPage schema added to all five pages and matching the visible text.
- TechArticle schema added to all five pages.
- Cache purged.
- All eight verification steps completed.