Skip to content

Split docs for eagleeye - #621

Closed
0xharkirat wants to merge 7 commits into
mainfrom
split-docs-for-eagleeye
Closed

Split docs for eagleeye#621
0xharkirat wants to merge 7 commits into
mainfrom
split-docs-for-eagleeye

Conversation

@0xharkirat

@0xharkirat 0xharkirat commented Dec 30, 2025

Copy link
Copy Markdown
Member

Closes: https://github.com/SSWConsulting/SSW.EagleEye/issues/1418
This pull request restructures the EagleEye installation documentation into a multi-step format for improved clarity and user experience. The previous single-page guide has been split into four focused step-by-step guides, each with enhanced instructions, embedded video walkthroughs, and clearer sectioning. The changes also update references, navigation, and titles to match the new structure.

Documentation Restructuring and Content Organization:

  • The original installation and prerequisites content in prerequisites.mdx has been split into three new step-by-step guides: step-1-azure-setup.mdx, step-2-app-registrations.mdx, and step-3-install-from-marketplace.mdx, each covering a distinct phase of the setup process.
    Content Enhancement and Sectioning:

  • Each step now includes clear subsections (e.g., resource provider registration, tenant/group setup, app registration, deployment wizard, post-deployment configuration) and uses numbered headings for easier navigation.
    Improved Clarity and Guidance:

  • Instructions for Azure resource provider registration, tenant/group setup, app registrations, API permissions, and portal access control are now separated and expanded for clarity, including direct links to Microsoft documentation and visual aids.

  • The installation steps now detail each phase of the Azure Marketplace deployment wizard, including configuration of resources, app registrations, database, and Azure OpenAI settings.

Navigation and Reference Updates:

  • Removed duplicate and outdated content from the original files; updated references and next steps to match the new multi-step structure.

File Renaming and Cleanup:

  • Files have been renamed for consistency (installation.mdxstep-3-install-from-marketplace.mdx, step-4-integrate-power-bi-report.mdxintegrate-power-bi-report.mdx), and obsolete sections have been removed to prevent confusion.

This PR has been closed to resolve a stuck merge state. A new PR with the same branch and description will be opened immediately.

@vercel

vercel Bot commented Dec 30, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
ssw-products Ready Ready Preview, Comment Dec 30, 2025 10:38pm

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All done

Comment thread content/docs/EagleEye/step-2-app-registrations.mdx Outdated
Comment thread content/docs/EagleEye/step-2-app-registrations.mdx Outdated
@0xharkirat
0xharkirat marked this pull request as draft December 30, 2025 07:17
auto-merge was automatically disabled December 30, 2025 07:17

Pull request was converted to draft

@0xharkirat
0xharkirat marked this pull request as ready for review December 30, 2025 07:17
@0xharkirat
0xharkirat enabled auto-merge (squash) December 30, 2025 07:17
@SSWConsulting SSWConsulting deleted a comment from Copilot AI Dec 30, 2025
@0xharkirat 0xharkirat closed this Dec 30, 2025
auto-merge was automatically disabled December 30, 2025 22:25

Pull request was closed

@0xharkirat 0xharkirat reopened this Dec 30, 2025
@0xharkirat 0xharkirat closed this Dec 30, 2025
@0xharkirat 0xharkirat reopened this Dec 30, 2025
@0xharkirat
0xharkirat requested a review from Copilot December 30, 2025 22:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (4)

content/docs/EagleEye/step-4-integrate-power-bi-report.mdx:8

  • The date is set to a future date (2025-11-26) which should likely be 2024-11-26 or updated to the actual publication date. Future dates in documentation can cause confusion and may affect sorting or display logic.
    content/docs/EagleEye/step-3-install-from-marketplace.mdx:9
  • The date is set to a future date (2025-12-29) which is beyond the current knowledge cutoff. This should be corrected to a valid past or present date to avoid confusion and potential issues with date-based systems.
    content/docs/EagleEye/step-4-integrate-power-bi-report.mdx:35
  • The indentation of the image markdown is inconsistent. Lines 20, 22, and 27 use 3 spaces for indentation under numbered list items, while lines 31, 33, and 35 also use 3 spaces. However, proper markdown list continuation requires 3 spaces (for single-digit items) or 4 spaces (for double-digit items). Line 35 is under item 10 (double-digit) and should use 4 spaces instead of 3 for proper alignment.
    content/docs/EagleEye/step-4-integrate-power-bi-report.mdx:6
  • The word "visualisation" uses British English spelling. For consistency, verify whether the documentation should use American English spelling "visualization" or British English spelling "visualisation" throughout. Most technical documentation uses American English by default.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread content/docs/EagleEye/step-2-app-registrations.mdx
Comment thread content/docs/EagleEye/step-2-app-registrations.mdx
Comment thread content/docs/EagleEye/step-2-app-registrations.mdx Outdated
0xharkirat and others added 2 commits December 31, 2025 09:32
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@0xharkirat

Copy link
Copy Markdown
Member Author

Closing this PR because GitHub showed it as mergeable but kept the merge state stuck as blocked with a stale message about unresolved conversations, even though all review threads were resolved and checks were passing.

To avoid any further issues with the stuck state, the same branch and changes have been opened in a new PR: #623

Please use PR #623 for any further review and merging.

@0xharkirat
0xharkirat deleted the split-docs-for-eagleeye branch December 30, 2025 23:19
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.

3 participants