Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Thoughts on integration & integration docs #727

Open
mantrachain-support opened this issue Sep 5, 2024 · 1 comment
Open

Thoughts on integration & integration docs #727

mantrachain-support opened this issue Sep 5, 2024 · 1 comment

Comments

@mantrachain-support
Copy link

Referencing: https://github.com/skip-mev/connect/blob/main/docs/developers/integration.mdx

I'd like to make a suggestion that I think will make connect much easier to integrate.

Currently, in the docs we have:

  • app wiring (occurs in app.go)
  • ABCI extensions (should occur in a file named app/abci_extensions.go)
  • Oracle client (should occur in app/oracle_client.go)
  • setup markets (should occur in app/setup_markets.go)

providing these files in their complete form, for use as pasta, is likely the best way to present the integration step of the process.

After that, there could be another document:

Referencing: https://github.com/skip-mev/connect/blob/main/docs/developers/customization.mdx

and in the customization document, we could guide developers through any possible tweaks.

@Eric-Warehime
Copy link
Collaborator

We can look into this--for now the Skip team takes a large role in most of the integrations so we're pretty comfortable with weaving these components into the existing app structure. The other consideration is that each app is in general structured differently and can potentially be constructed differently w/r/t depinject, etc. so it's likely that 1 size fits all wouldn't track very well in practice here.

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

No branches or pull requests

2 participants