Coder Social home page Coder Social logo

phalcon-orphanage / docs-app Goto Github PK

View Code? Open in Web Editor NEW
14.0 14.0 19.0 74.6 MB

Official Phalcon documentation website.

Home Page: https://docs.phalcon.io

License: Other

Shell 1.49% CSS 4.26% JavaScript 25.12% HTML 60.52% Ruby 0.29% PHP 8.33%
docs documentation phalcon phalcon-documentation php website

docs-app's People

Contributors

arhell avatar asokal avatar cameronhall avatar challet avatar dzantiev avatar emiliodeg avatar garyanewsome avatar niden avatar ninjapanzer avatar olegatro avatar quasipickle avatar rom1detroyes avatar ruudboon avatar sergeyklay avatar sidroberts avatar spurius96 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs-app's Issues

Make left menu section visible by default

It's very hard to see this menu at the first time. Also it is harder to focus when you need to move mouse and navigate between anchors.

Probably would be better to make some button which will toggle display of that menu.

Home page

Reviewing the application of the documentation a bit I found these 2 errors

  1. The home page does not have support to translate to other languages
  2. Correct flags that represent languages. currently for the arabic language the flag of ARgentina is shown, check the rest of the flags

@niden if you want I can take care of them

URL Site Bug

Make title clickable to anchor

If the title of an article contains an anchor we see the # in front. Can we make this title clickable so I can easily copy past the url with the anchor?

The banner on the top is unnecessarily large and floaty

From @dschissler on July 11, 2017 22:29

I think that its bad enough that its very difficult to buy a screen that is not 16x9 because there is so much less vertical space then there used to be so that its like permanently driving with the sun visor down. Now with the banner on the top its like have two sun visors. I'd really prefer if it didn't float at all. Its enough that it just appear once at the top. In this case its fancy CSS that is reducing the usability. Also I would like the banner to be 5-10px smaller. Lets get some work done.

Copied from original issue: phalcon-orphanage/docs#1116

Enable SSL

We'll need to enable https as default protocol for docs.phalconphp.com.

// cc @niden

broken links

Hello.
links do not work in the community menu:

Resources

possible typo in 3.4 installion macOS section

In the 3.4 installation guide, under the #Macports section it says to add "extension=php_phalcon.so" to php.ini. Shouldn't it be just "extension=phalcon.so"? Also, for the macOS platform, this is only explained under the Macports section. I don't know if you also need to add it if using brew, but we are compiling from source and I had to of course add it.

Optimize performance

I've looked a bit into the performance of our docs.
I think we can speed it a up a bit more by doing the following.

  • Load all fonts from google fonts
  • Use smaller subset in google fonts (do we really need all the characters on all pages?)
  • Ask Netlify to fix caching of files.

Screenshot 2019-08-26 at 17 17 01
Screenshot 2019-08-26 at 17 16 37
Screenshot 2019-08-26 at 17 16 30

Wrong webserver setup

There is an issue with URI ended with index.php/.

curl -I https://docs.phalconphp.com/index.php/

Expected response

HTTP/1.1 302 Found
Date: Sun, 09 Dec 2018 18:55:11 GMT
Content-Type: text/html; charset=UTF-8
Connection: keep-alive
Set-Cookie: __cfduid=d4b25eb390e74f4663d4aea7af736dac41544381710; expires=Mon, 09-Dec-19 18:55:10 GMT; path=/; domain=.phalconphp.com; HttpOnly
Location: https://docs.phalconphp.com/en/3.4
X-UA-Compatible: IE=Edge
Cache-Contol: public, max-age=7200
X-Powered-By: Phalcon (https://phalconphp.com/)
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Server: cloudflare
CF-RAY: 4869af3d5f118412-KBP

Actual response

HTTP/1.1 404 Not Found
Date: Sun, 09 Dec 2018 18:54:25 GMT
Content-Type: text/html; charset=UTF-8
Connection: keep-alive
Set-Cookie: __cfduid=d1e20e72c6dec1fd7c94b6023d75cf5a91544381664; expires=Mon, 09-Dec-19 18:54:24 GMT; path=/; domain=.phalconphp.com; HttpOnly
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Server: cloudflare
CF-RAY: 4869ae1d19cc8b76-KBP

Search in version 4.0

I am searching function, method, class or anything but mostly found in v3.4.
I am using v4.0.
Any options for search in v4.0 documentation?

768 bug

fix this problem #143
this bug in the highlight block when a long line
bug

Documentation title missing info

Currently all a lot of page titles are missing info.

<title>Phalcon Documentation - </title>

https://docs.phalcon.io/4.0/en/introduction

I would like the page title to contain info about the page for better SEO performance.
Can we do something like this:

<title>Introduction - Phalcon Documentation</title>

This should also be reflected in the social meta tags.

Lowercase url's in sitemap

I'm seeing some issues regarding our sitemap.
Our sitemap contains url's with uppercase characters while our webserver is only serving lowercase (redirect if you enter uppercase). This is causing issues with indexing.

Don't think this is possible yet with out plugin. Opened an issue to this feature. See jekyll/jekyll-sitemap#251

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.