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: Interactivity API - Rename "API Reference" to "Directives and Store API Reference" #61207

Open
juanmaguitar opened this issue Apr 29, 2024 · 1 comment
Assignees
Labels
[Feature] Interactivity API API to add frontend interactivity to blocks. Good First Issue An issue that's suitable for someone looking to contribute for the first time [Type] Developer Documentation Documentation for developers

Comments

@juanmaguitar
Copy link
Contributor

juanmaguitar commented Apr 29, 2024

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 #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 #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:

  • Change the title of "API Reference" to "Directives and Store API Reference"
  • Change the filename to directives-store-api-reference.md

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

@juanmaguitar juanmaguitar self-assigned this Apr 29, 2024
@juanmaguitar juanmaguitar added [Type] Developer Documentation Documentation for developers [Feature] Interactivity API API to add frontend interactivity to blocks. labels Apr 29, 2024
@gziolo gziolo added the Good First Issue An issue that's suitable for someone looking to contribute for the first time label Jun 13, 2024
@piyush-sri
Copy link

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

piyush-sri added a commit to piyush-sri/gutenberg that referenced this issue Jun 25, 2024
…ractivity api section to address issue

WordPress#61207 fixed this issue with this changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Interactivity API API to add frontend interactivity to blocks. Good First Issue An issue that's suitable for someone looking to contribute for the first time [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

3 participants