Skip to content

Add developer guides and restructure documentation - #2

Open
shrukul wants to merge 15 commits into
mainfrom
feature/docs
Open

shrukul wants to merge 15 commits into
mainfrom
feature/docs

Conversation

@shrukul

@shrukul shrukul commented Apr 15, 2026 •

Copy link
Copy Markdown
Collaborator
  • Adds four new guides: Authentication, Core Concepts, Quickstart, and Using Postman
  • Restructures navigation (config.md) with correct sidebar hierarchy and page order
  • Removes dummy/placeholder guide pages and stub support pages
  • Updates landing page with accurate product overview and links
  • Updates Swagger spec

@shrukul shrukul self-assigned this Apr 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-15T19:34:30.843Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 12

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/api/1-4.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/dummy_metrics_api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/dummy_oauth_client/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/dummy_using_postman/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/migrating/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/support/FAQ/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/support/community/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/support/contribute/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    12
  📄 Files with issues:  9
  ❌ Total errors:       0
  ⚠️  Total warnings:     9
  📋 Total issues:       9

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@shrukul shrukul closed this Apr 15, 2026
@shrukul shrukul reopened this Apr 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-15T19:37:01.078Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 12

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/api/1-4.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/dummy_metrics_api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/dummy_oauth_client/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/dummy_using_postman/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/migrating/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/support/FAQ/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/support/community/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/support/contribute/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1:1
    Message: Missing frontmatter section - add --- at the beginning with title and description
    Rule: check-frontmatter


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    12
  📄 Files with issues:  9
  ❌ Total errors:       0
  ⚠️  Total warnings:     9
  📋 Total issues:       9

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-28T10:47:59.362Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 8

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/authentication/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 23:73
    Message: Unexpected dead URL `https://helpx.adobe.com/enterprise/admin-guide.html/enterprise/using/manage-developers.ug.html`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    8
  📄 Files with issues:  1
  ❌ Total errors:       0
  ⚠️  Total warnings:     1
  📋 Total issues:       1

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@shrukul shrukul changed the title Use pruned-down index.md until GA, Update Swagger Add developer guides and restructure documentation Apr 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-28T11:07:32.274Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 8

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/authentication/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 23:73
    Message: Unexpected dead URL `https://helpx.adobe.com/enterprise/using/manage-developers.html`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    8
  📄 Files with issues:  1
  ❌ Total errors:       0
  ⚠️  Total warnings:     1
  📋 Total issues:       1

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-28T11:41:03.612Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 8

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/authentication/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 23:73
    Message: Unexpected dead URL `https://helpx.adobe.com/enterprise/using/manage-developers.html`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    8
  📄 Files with issues:  1
  ❌ Total errors:       0
  ⚠️  Total warnings:     1
  📋 Total issues:       1

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-28T11:48:24.621Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 8


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    8
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@shrukul
shrukul requested a review from AEAbreu-hub April 28, 2026 17:46

@AEAbreu-hub AEAbreu-hub left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of good content and clean up you've done here. I haven't done a careful edit review yet, but it's passing the lint checks so I won't hold up the content at this stage. Let's get the info out and polish it over time. Thanks for the work here.

Shrukul Habib added 2 commits April 30, 2026 02:09
- Use US English spelling (organization) throughout
- Remove passedCount from validationSummary — API only returns failed counts
- Remove ruleId from validation error responses to avoid exposing internal rule identifiers
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-29T20:46:27.139Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 8


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    8
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

- Correct asset request body: nodeId/url → clientItemId and nested asset object with mediaType and value
- Correct item response fields: nodeId → clientItemId, validationSummary → summaryText, validationErrors → errorId/errorSummary
- Add item-level status values to Core Concepts
- Fix pagination documentation: pageSize parameter, scoped to jobs list endpoint only
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-29T21:00:51.409Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 8


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    8
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

- Clarify resource hierarchy: items map 1:n to assets (one per image, one per page for multi-page documents)
- Replace bb-cortex.adobe.io with abi.adobe.io across docs and OpenAPI spec
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-29T21:11:31.198Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 8


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    8
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

Shrukul Habib added 2 commits April 30, 2026 03:41
- Add guide covering comment listing, creation, and update (accept, reject, edit) on validation items
- Fix Quickstart "What's next" link to point to the new guide
- Reorder sidebar: Review Feedback before Using Postman
- Add `assetAttributions` and `corpusAttributions` to Core Concepts and Quickstart response example, including normalised bounding box coordinates
- Add pointer to full `BrandValidationError` schema in Review Feedback guide
- Add API Reference links on all response examples for omitted fields
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-04-29T22:22:51.794Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 9


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    9
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@github-actions

github-actions Bot commented May 4, 2026

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-05-04T18:26:59.118Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/abi-docs/abi-docs

───────────────────────────────────────────────────────────────

Files to process: 9


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    9
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

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.

2 participants