Geeklog Forums

Where is the best directory for plugin's document?

1. documents for admin user
<public_html>/admin/<Plugin name>/docs/japanese/*****.html
(for admin panel and configuration help)

2. help for user
<public_html>//<Plugin name>/help/japanese/*****.html

Right?

---

Geeklog Japan https://www.geeklog.jp

There is no real standard. Maybe we should make one...

We also have the directory <public_html>/help/ which some plugins use

Tom

---

One of the Geeklog Core Developers.

Please.

core plugin use /docs/(language)/.
Can other plugins use this directory, too?

---

Geeklog Japan https://www.geeklog.jp

I would rather not. I would actually like to unbundle the core plugins from Geeklog (at some point). I would still keep them as part of the Geeklog install but make them completely independant of Geeklog (there are only a few things left to do).

Do you think we can keep all the online documents for a plugin under public_html/plugin_name/docs/language/ or should the admin docs be in the admin directory (ie public_html/admin/plugin_name/docs/language/)?

Does anyone else have a preference?

I wonder also if we should use the language code for the language directory? This way Geeklog could automatically point the user to the docs in the language the user is using to view the site.

---

One of the Geeklog Core Developers.

public_html / (plugin_name) / docs / language / (plugin_name). html
( or public_html /admin/plugins/ (plugin_name) / docs / language / (plugin_name). html)

Want to relation the following files:
public_html / docs / docstyle.css
public_html / docs / language / docstyle.css
public_html / docs / images /

my preference is

the admin docs be in the admin directory (ie public_html /admin/plugins/ (plugin_name) / docs / language / (plugin_name). html)

How about this then:

1. documents for admin user
<public_html>/admin/<Plugin name>/docs/japanese/*****.html
(for admin panel and configuration help)

2. documents/help for user
<public_html>/<Plugin name>/docs/japanese/******.html

I switched the help directory to docs that Ivy suggested just to keep things uniform. We should also always include an index.html file in these directories as a starting point.

Tom

---

One of the Geeklog Core Developers.

Tom,

Thanks!
It's nice,

---

Geeklog Japan https://www.geeklog.jp