From cf10e5b76424886774ae871cce83b6814a6d5b2f Mon Sep 17 00:00:00 2001 From: Matthew Brown Date: Tue, 19 Mar 2019 18:37:39 -0400 Subject: [PATCH] Improve index --- docs/index.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/docs/index.md b/docs/index.md index e516691ca..5c24b33fd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,24 +1,26 @@ -# About Psalm +- [About Psalm](#about-psalm) +- [Introduction](#introduction) +- Running Psalm: + - [Installation](installation.md) + - [Configuration](configuration.md) + - [Plugins](plugins.md) + - [Command line usage](running_psalm.md) + - [IDE support](language_server.md) + - Handling errors: + - [Dealing with code issues](dealing_with_code_issues.md) + - [Issue Types](issues.md) + - [Checking non-PHP files](checking_non_php_files.md) +- Annotating code: + - [Typing in Psalm](typing_in_psalm.md) + - [Docblock Type Syntax](docblock_type_syntax.md) + - [Supported Annotations](supported_annotations.md) + - [Template Annotations](templated_annotations.md) + - [Fixing code](fixing_code.md) + +## About Psalm [Psalm](https://getpsalm.org) is a static analysis tool that attempts to dig into your program and find as many type-related bugs as possible. -- [Introduction](#introduction) -- [Installation](installation.md) -- [Configuration](configuration.md) -- Using Psalm - - [Running Psalm via command line](running_psalm.md) - - [Running Psalm in your IDE](language_server.md) -- [Using Psalter](fixing_code.md) -- [Dealing with code issues](dealing_with_code_issues.md) - - [Issue types](issues.md) -- [Typing in Psalm](typing_in_psalm.md) - - [Supported Annotations](supported_annotations.md) - - [Templated Annotations](templated_annotations.md) -- [Plugins](plugins.md) -- [Checking non-PHP files](checking_non_php_files.md) -- [How Psalm works](how_psalm_works.md) - - [Things that make developing Psalm complicated](what_makes_psalm_complicated.md) - ## Introduction Psalm tries to understand your codebase as best as possible so it can find errors. @@ -62,5 +64,6 @@ ERROR: InvalidArgument - somefile.php:3:14 - Argument 1 of implode expects `stri ## Inspirations There are two main inspirations for Psalm: - - Etsy's [Phan](https://github.com/etsy/phan), which uses nikic's [`php-ast`](https://github.com/nikic/php-ast) extension to create an abstract syntax tree - - Facebook's [Hack](http://hacklang.org/), a PHP-like language that supports many advanced typing features natively, so docblocks aren't necessary. + +- Etsy's [Phan](https://github.com/etsy/phan), which uses nikic's [`php-ast`](https://github.com/nikic/php-ast) extension to create an abstract syntax tree +- Facebook's [Hack](http://hacklang.org/), a PHP-like language that supports many advanced typing features natively, so docblocks aren't necessary.