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

Glossary scope and references #43

Open
waalge opened this issue Aug 27, 2024 · 1 comment
Open

Glossary scope and references #43

waalge opened this issue Aug 27, 2024 · 1 comment
Labels
proposed A new term to add to the glossary

Comments

@waalge
Copy link
Contributor

waalge commented Aug 27, 2024

A general comment here regarding the orcfax glossary.

(It is my opinion that) We should liberally rely on external sources for definitions.
Especially where:

  • Where a term or concept is not part of orcfax's core protocol or
  • Our usage does not diverge in any meaningful way from the "generally accepted usage"

I would say "inline datum" meets both of these criteria. At worst we should be just signposting "See cip32".

Related: referencing :otherTerm infers that otherTerm is also an orcfax term. : is short hand for "glossary.orcfax.io". Given our current immaturity, we accept that these are not yet written, but :otherTerm should be in the scope outlined above.
Otherwise this should be an external source eg dictionaryOfComputerTerms:otherTerm

@waalge waalge added the proposed A new term to add to the glossary label Aug 27, 2024
@Christian-MK
Copy link
Contributor

This makes sense to me! makes our job easier

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposed A new term to add to the glossary
Projects
None yet
Development

No branches or pull requests

2 participants