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

chore(docs): adding quick reference to oracles, guide and explainer to follow #3975

Closed
wants to merge 1 commit into from

Conversation

signorecello
Copy link
Contributor

Description

Adds almost a "dummy" page on Oracles to the reference section (here called "concepts" due to the almost inevitable mix between explanations and language reference)

Problem*

Closes #3971

Summary*

  • Adds an "oracles" page to the concepts section simply explaining how to use the flag and mentioning the RPC server. Intentionally, there is no info on how to write the RPC server and how to pass it to the oracle function, as that falls outside of the scope of the language, and thus should be part of a how-to guide
  • Updates sibebar item order and adds it to Traits. This is mostly unecessary but for the time being we can totally manage them and profit from controlling sidebar ordering

Additional Context

We can almost consider this 1/3 of the work, so I'm glad making it a draft now and add it to a bigger PR with the guide/explainer. Just wanted to close #3971 for the time being

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 8, 2024
@signorecello signorecello requested review from TomAFrench, Savio-Sou and a team January 8, 2024 10:55
Copy link
Contributor

github-actions bot commented Jan 8, 2024

@Savio-Sou
Copy link
Collaborator

part of a how-to guide
That's going into the "How To Guides" section of the docs right?

In that case would prefer closing #3971 when we have the guide ready for merging instead.

(Feel free to update the original Issue for better alignment with the diátaxis framework if need to.)

@TomAFrench
Copy link
Member

tbh, this seems to give just enough information to entice extra questions on this topic without allowing users to actually use these. This is probably counterproductive in terms of saving time spent helping people use oracles

@signorecello
Copy link
Contributor Author

Agreed! Making it a draft and reusing this branch for the rest of it

@signorecello
Copy link
Contributor Author

Superseeded by #4002

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the #[oracle] attribute
3 participants