Coder Social home page Coder Social logo

wintercms / wn-docs-plugin Goto Github PK

View Code? Open in Web Editor NEW
4.0 4.0 9.0 509 KB

Plugin that provides documentation direct to your Winter CMS installation.

License: MIT License

PHP 88.80% JavaScript 3.50% Less 2.43% HTML 3.75% Twig 1.52%
hacktoberfest

wn-docs-plugin's People

Contributors

ben-nl avatar bennothommo avatar chkilel avatar der-on avatar kocbek avatar luketowers avatar mjauvin avatar romainmazb avatar webvpf avatar wpjscc avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

wn-docs-plugin's Issues

PageList not found error

Hello,
i install fresh wintercms and docs plugin then click the docs button in backend menu bar following errors are shows me.

Class "Winter\Docs\Classes\PagesList" not found
C:\xampp\htdocs\winter\plugins\winter\docs\controllers\Index.php line 79

how to solve this error?

Search should search through contents, not just TOC

As a user I want to be able to search the docs.

Current behaviour

  • I enter a search term into the search box
  • the TOC gets filtered by the search term

Expected behaviour

  • I enter a search term into the search box
  • I get a list of search results either below the search box (autocomplete) or in the main content area

PDF builder functionality

Many less technical users find it easier to work with printed documentation, so it may be a good idea to provide a way for users to print off PDF copies of the documentation guides / manuals present on their system.

Support permissions for guides / manuals & Table of Contents

We should support documentation to be locked behind permissions, both on the overall guides / manuals as well as on the individual permissions.

This will make it a lot easier for developers to automatically scope the content that is presented to the end user because they can reuse the same permissions that any given functionality is locked behind in order to block access to the documentation for that functionality; thus ensuring that users without access to do a given action won't have to see the documentation for something they cannot themselves do. We can also make this system optional by way of a winter.docs.view_all permission that can bypass any permissions set on the documentation content if desired.

Helpers section does not contain any helpers

As a user I want to see the available helper functions

Current behaviour

  • I open the Helpers section in the left hand menu
  • The main content area just displays a single paragraph but no helpers

Expected behaviour

  • I open the Helpers section in the left hand menu
  • The main content area displays all available helpers

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.