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: Write initial Addons documentation page #11425

Closed
ericholscher opened this issue Jun 18, 2024 · 1 comment
Closed

Docs: Write initial Addons documentation page #11425

ericholscher opened this issue Jun 18, 2024 · 1 comment
Assignees

Comments

@ericholscher
Copy link
Member

ericholscher commented Jun 18, 2024

The idea here is probably for @humitos to write an initial draft and work with @plaindocs as a primary editor.

@plaindocs
Copy link
Contributor

OK, @humitos and I chatted about this and reckon the following is a decent approach:

  • Find a home for each separate addon within the most relevant section of the existing docs structure (more details on that below)

    • Focus on docs for maintainers (readers shouldn't really need them)
    • Leave advanced js/json config for last
  • Add a new Addons page or section listing+linking them with a short description (kinda like the existing marketing page)

    • Add a config section around enabling the addons, or where they are on by default

For homes for addons, I'm thinking something like

  • Analytics -> hosting documentation
  • DocDiff -> Build process (PR previews)
  • PR notification -> Build process (PR previews)
  • Version flyout -> Reading documentation
  • non-stable notification (have we thought about merging the three banner sections in the docs) -> reading documentation
  • latest notification -> reading documentation
  • search as you type -> reading documentation (cross linked from search in hosting docs)
  • Sponsorship -> reading docs

And while I'm there, doing some refactoring of existing related pages that are replaced by the new addons (being phased out), including

I'll get started on this early next week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants