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

docs: Make section def more useful #2769

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

salim-b
Copy link
Contributor

@salim-b salim-b commented Nov 18, 2024

Note that this section definition clearly overlaps with the glossary entry for "section". If we would convert the glossary terms to structured data, we could actually re-use them at various places. What do you think @jmooring? I can open a separate issue if you agree.

@jmooring
Copy link
Member

convert the glossary terms to structured data

Let's leave it as-is and copy/paste when necessary, which isn't very often.

@salim-b
Copy link
Contributor Author

salim-b commented Nov 19, 2024

Let's leave it as-is and copy/paste when necessary, which isn't very often.

In that case I'd suggest to remove this "definition-of-section" snippet from most places (e.g. like here) and instead link to the glossary term where applicable. It's confusing.

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