Skip to content

Conversation

@devin-ai-integration
Copy link

Add comprehensive Hex documentation with 14-day visibility limitation

Summary

Replaces the placeholder Hex documentation (which was just a card linking to a Tally form) with comprehensive user-facing setup documentation. The new documentation follows the same structure as other BI tool integrations (like Sigma) and includes the critical 14-day visibility limitation as specified in the Linear ticket ELE-5071.

Key additions:

  • Complete API token creation instructions with link to official Hex docs
  • Step-by-step connection setup in Elementary's Account settings
  • Limitations section highlighting both dataset exclusion and 14-day visibility requirement
  • Consistent formatting with other BI tool documentation

The 14-day limitation is based on the days_back: int = 14 parameter found in HexQueryHistoryReader.read_hex_queries_from_history() in the elementary-internal codebase.

Review & Testing Checklist for Human

  • Verify the 14-day limitation is technically accurate - Check that HexQueryHistoryReader implementation actually uses 14 days and that this matches the user-visible behavior
  • Test the setup instructions end-to-end - Follow the API token creation and Elementary connection steps to ensure they work with the current Hex and Elementary UIs
  • Check the API token documentation link - Verify the Hex docs link is current and leads to the correct instructions

Notes

- Replace placeholder card with user-facing setup documentation
- Follow Sigma documentation structure and format
- Include API token creation and connection setup instructions
- Add critical 14-day visibility limitation based on HexQueryHistoryReader implementation
- Maintain consistency with other BI tool documentation

Fixes ELE-5071

Co-Authored-By: Yosef Arbiv <[email protected]>
@devin-ai-integration
Copy link
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@linear
Copy link

linear bot commented Sep 17, 2025

ELE-5071 add hex docs

@coderabbitai
Copy link

coderabbitai bot commented Sep 17, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ele-5071-1758098454-add-hex-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

- Remove mention of datasets being excluded from computed lineage graph
- Keep only the 14-day visibility limitation in the Limitations section
- Addresses user feedback on PR #2010

Co-Authored-By: Yosef Arbiv <[email protected]>
…leges

- Replace generic 'Read privileges' text with specific workspace token requirements
- Use exact text from HexDialogForm: 'read access for all categories and read project queried tables'
- Update documentation link to official Hex workspace tokens documentation
- Addresses user feedback on PR #2010

Co-Authored-By: Yosef Arbiv <[email protected]>
@NoyaOffer NoyaOffer merged commit a11c84a into docs Sep 17, 2025
5 of 6 checks passed
@NoyaOffer NoyaOffer deleted the ele-5071-1758098454-add-hex-docs branch September 17, 2025 09:56
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