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

Put a link to the api in the left menu #404

Open
Ruslan-Aleev opened this issue Apr 25, 2022 · 2 comments
Open

Put a link to the api in the left menu #404

Ruslan-Aleev opened this issue Apr 25, 2022 · 2 comments

Comments

@Ruslan-Aleev
Copy link
Contributor

Ruslan-Aleev commented Apr 25, 2022

Request for new documentation

It seems to me that it is worth duplicating the link to api.modx.com in the main menu on the left.
The section is important, but it is hidden in a nested section, and it will not be easy for a beginner to find it quickly.

left_menu

It would also be useful to update api.modx.com.
The site looks outdated and seems to be abandoned (even the favicon is ancient :) ).

api

@Mark-H
Copy link
Collaborator

Mark-H commented Apr 25, 2022

Yeah, that site's ancient.

I wouldn't be opposed to the idea of actually creating something that parses the modxcms/revolution repo and writes it into this repo directly, so we just add an "API Reference" section in either version branches that we can easily keep updated. Something like this, perhaps.

@Ruslan-Aleev
Copy link
Contributor Author

Ruslan-Aleev commented Apr 25, 2022

Cool idea! It would also be great to generate a dock for modx-extJs solutions in the same format, if possible (at least based on comments in js files). To somehow also centralize the documentation and make it comprehensive. It's just that the extJs dock for version 3.4 may close sooner or later.

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

No branches or pull requests

2 participants