WordPress / gutenberg

The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
https://wordpress.org/gutenberg/
Other
10.29k stars 4.11k forks source link

Docs: Interactivity API - Rename "API Reference" to "Directives and Store API Reference" #61207

Open juanmaguitar opened 4 months ago

juanmaguitar commented 4 months ago

After moving Interactivity API docs to Block Editor Handbook > Reference Guides > Interactivity API Reference, the structure of this sections is as follows:

As the word "Reference" will be kept for now (see https://github.com/WordPress/gutenberg/issues/60782) for any subpage below Reference Guides, with the current structure, it may be a bit confusing having "Interactivity API Reference" and "API Reference" different pages on the same section.

Also, as per the current issue with docs generation explained at https://github.com/WordPress/gutenberg/issues/61206 having an api-reference.md file may cause conflict in the future with any other api-reference.md file under any other section.

To solve this situation, I suggest the following actions:

This change would require a redirection.

Another option could be to simply remove the "Reference" word from "Interactivity API Reference", but this would go against the rule followed by the rest of subsections under Reference Guides

cc: @ndiego @cbravobernal @sirreal @luisherranz

piyush-sri commented 2 months ago

I would like to work on this issue could you please assign this task to me

spencerfinnell commented 2 weeks ago

This should also help Google:

Screenshot 2024-08-21 at 5 50 34 PM