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

Documentation Link setup in Admin #267

Open
6 tasks
acketon opened this issue Jun 14, 2021 · 3 comments
Open
6 tasks

Documentation Link setup in Admin #267

acketon opened this issue Jun 14, 2021 · 3 comments

Comments

@acketon
Copy link
Member

acketon commented Jun 14, 2021

Requirements

  • A standardized way of adding a documentation link to the WordPress admin bar is added.
  • The method of adding the documentation link should not be inherently BU-specific; ie, someone using this on an open source project should be able to provide their own documentation URL.
  • If any BU-specific code is needed, it should be located in https://github.com/bu-ist/bu-responsive-customizations/
  • A method of adding CSS or changing the display of a page on the documentation domain should be available to a designer.
  • A method of using a different page template for the front page of a documentation site should be available to a developer.
  • The final proposed direction should consider the use cases and common tactics we've used that Alana has summarized in https://github.com/bu-ist/responsive-framework-1x/issues/245

Original Request

In custom themes we add a documentation link to the menu bar. I believe this is done via PHP like in Theology theme here: https://github.com/bu-ist/r-theology/blob/e81600b0ec23a84c70ed1b738c11af8a8952912b/functions.php#L532

However, in Custom CSS only sites and/or Companion theme sites there is not a method to do this via the admin. I propose adding a site option and/or admin settings page that would allow ID Admins the ability to add the url to the documentation site from within the WP admin instead of doing it in code only.

@ashleykolodziej
Copy link
Contributor

Next steps:

  • Determine how this is added to framework (BU Responsive Customizations)?

@ashleykolodziej
Copy link
Contributor

Alana wrote some good use cases for this over here: https://github.com/bu-ist/responsive-framework-1x/issues/245

@saucyrooster
Copy link

Additionally, I believe that the documentation should be a standard theme/look & feel across ALL documentation. ie: Child themes, products and plugins.
Proposed Mocks

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

No branches or pull requests

3 participants