leafsphp / docs Goto Github PK

View Code? Open in Web Editor NEW

8.0 2.0 52.0 16.33 MB

🤫 New documentation for leaf and components

Home Page: https://leafphp.dev

License: Other

JavaScript 59.18% Vue 2.83% CSS 36.40% TypeScript 0.86% HTML 0.21% PHP 0.48% Hack 0.03%

leafphp documentation

docs's Introduction

Leaf 3

Contributing

This site is built with VitePress and depends on @leafphp/docs-theme. Site content is written in Markdown format located in src. For simple edits, you can directly edit the file on GitHub and generate a Pull Request.

For local development, pnpm is preferred as package manager:

pnpm i
pnpm run dev

This project requires Node.js to be v14.0.0 or higher, because we use new JavaScript features in our code, such as optional chaining.

Working on the content

See VitePress docs on supported Markdown Extensions and the ability to use Vue syntax inside markdown.
See the Writing Guide for our rules and recommendations on writing and maintaining documentation content.

docs's People

Contributors

Stargazers

Watchers

docs's Issues

[feature request] New in ...

v1 documentation had a section on the homepage featuring new features in Leaf. This was relatively helpful and would be nice to have this back in the v3 docs.

Link to discussion is 404 on website

On your website https://leafphp.dev there is a menu entry "Community > Leaf Forum" that points to https://github.com/leafsphp/leaf/discussions/57

When clicking this link, I get a 404 from GitHub.

Bug with the custom blocks and the sidebar on mobile

Description

I feel like the migration of the documentation caused a small display problem. Indeed it seems that the theme used is a bit buggy.

The little icon on custom blocks is now above the sidebar when it is expanded on mobile devices.

This id probably just a z-index problem.

Screenshots

Add some documentation about the $template

I find it strange that in the Leaf documentation it does not mention anything about the $template variable that is defined for the template to be rendered. It is really very useful to know that you can use $template to render templates within templates in order to compose the UI

Content-Type in example might be wrong

Is the Content-Type of the response in this example correct? Since the endpoint is returning HTML should the content-type be JSON?

Update Middleware docs

"the documentation for the Middleware is not comprehensive enough".

Docs should start from basics and talk extensively about the different kinds of middleware and how they should be used

Update Error handling mechanism docs

Error handling docs are currently hidden somewhere around routing/config. It should be pretty obvious from the get go how all of those stuff work.

Update Leaf Auth Documentation

Documentation for Leaf auth is not "extensive" enough.

It needs to address "unusual" things like the id and password being hidden for security reasons.
Also needs extensive explanations on token flow for beginners