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

Discussion: Dealing with Disambiguation in the Godot Manual #10536

Open
betalars opened this issue Jan 21, 2025 · 1 comment
Open

Discussion: Dealing with Disambiguation in the Godot Manual #10536

betalars opened this issue Jan 21, 2025 · 1 comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features discussion

Comments

@betalars
Copy link
Contributor

This has popped up in my mind when I was thinking about enhancing the documentation of Addons and Plugins

I think the difference between plugins, addons, gdextension, tools and modules may not really be clear to many users and could need a disambiguation wiki page.

A good place in my opinion would be a dedicated disambiguation section in the manual. However that would 100% leave the scope of just enhancing the plugin/addon documentation. I think it would also need more than just one use-case to warrant its existence.

Hence I am opening this discussion to collectively think about:

  1. are there other areas in Godot that would benefit from disambiguation?
  2. what is the best way to implement that?
@tetrapod00
Copy link
Contributor

In this case, a new short page in the Plugins section makes sense to me. If it's very short it could also exist in the index page itself.

At first glance, for other cases I don't think we need a full separate disambiguation page/section yet. I don't really think it fits the current form of the manual. In most cases, either of the following will suffice:

  • A see also box on one or both of the relevant pages, if one is very commonly confused for the other.
  • A section which describes the differences between the options and suggests when to use each. This isn't really disambiguation but it is explaining multiple options and clarifying the differences between them.

Some existing sections that are sort of like a disambiguation:

@tetrapod00 tetrapod00 added discussion content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features discussion
Projects
None yet
Development

No branches or pull requests

2 participants