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.

Sign up for GitHub

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

Jump to bottom

Add a Glossary or something similar #621

Open
glozow opened this issue Feb 7, 2023 · 2 comments · May be fixed by #639
Open

Add a Glossary or something similar #621

glozow opened this issue Feb 7, 2023 · 2 comments · May be fixed by #639
Labels
enhancement New feature or request

Comments

@glozow
Copy link
Contributor

glozow commented Feb 7, 2023

It's perhaps worth keeping a glossary so we don't have to continuously re-define things like ancestor feerate, block-relay-only connections, effective fees in coin selection, etc. We sometimes link to previous review clubs, but that also doesn't offer a direct definition. Maybe something similar to bitcoinops topics (so it's easily linkable and back-linkable) but for low-level terms.
@glozow glozow added the enhancement New feature or request label Feb 7, 2023
@stickies-v
Copy link
Contributor

Agreed on the concept. Intuitively I'd try to avoid adding another (fragmented) source of information, though. Most topics can be probably just be added to bitcoinops? But the very Core-specific items I can imagine don't belong there. Still, I think I'd prefer adding to existing knowledge bodies. bitcoin-devwiki comes to mind, but... that's not very well organized atm.

@kouloumos kouloumos linked a pull request Mar 11, 2023 that will close this issue
Open
@jnewbery
Copy link
Contributor

Most topics can be probably just be added to bitcoinops? But the very Core-specific items I can imagine don't belong there. Still, I think I'd prefer adding to existing knowledge bodies. bitcoin-devwiki comes to mind, but... that's not very well organized atm.

For more high-level concepts that are user-visible or not specific to Bitcoin Core, I agree that we shouldn't be duplicating content here where we could just point to an external resource. However, the review club covers a lot of content that is either specific to Bitcoin Core internals (eg ConnMan), focused on protocol development (eg fuzz testing), or related to work-in-progress PRs/projects (eg package relay). I don't think there's an external resource that is appropriate for any of those things, and having a lightweight glossary on the site makes sense for those topics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Introduce Topics and bidirectional links between pages kouloumos/website
3 participants
@jnewbery @glozow @stickies-v