Skip to content

docs: fix grammar, markup and line width across the user guide #10709

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.

Sign up for GitHub

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

Merged
paulbalandan merged 2 commits into from
Nov 3, 2026
Merged

docs: fix grammar, markup and line width across the user guide #10709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9002edf
docs: fix grammar inconsistencies, false claims, etc.
paulbalandan Nov 3, 2026
c33dd62
docs: reflow lines within 120 columns
paulbalandan Nov 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 99 additions & 83 deletions user_guide_src/source/changelogs/v4.0.0-alpha.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,86 +12,102 @@ Release Date: September 28, 2018
New Packages List
-----------------

- API
- \\ ResponseTrait
- Autoloader
- \\ AutoLoader, FileLocator
- CLI
- \\ BaseCommand, CLI, CommandRunner, Console
- Cache
- \\ CacheFactory, CacheInterface
- \\ Handlers ... Dummy, File, Memcached, Predis, Redis, Wincache
- Commands
- \\ Help, ListCommands
- \\ Database \\ CreateMigration, MigrateCurrent, MigrateLatest, MigrateRefresh,
MigrateRollback, MigrateStatus, MigrateVersion, Seed
- \\ Server \\ Serve
- \\ Sessions \\ CreateMigration
- \\ Utilities \\ Namespaces, Routes
- Config
- \\ AutoloadConfig, BaseConfig, BaseService, Config, DotEnv, ForeignCharacters,
Routes, Services, View
- Database
- \\ BaseBuilder, BaseConnection, BasePreparedQuery, BaseResult, BaseUtils, Config,
ConnectionInterface, Database, Forge, Migration, MigrationRunner, PreparedQueryInterface, Query,
QueryInterface, ResultInterface, Seeder
- \\ MySQLi \\ Builder, Connection, Forge, PreparedQuery, Result
- \\ Postgre \\ Builder, Connection, Forge, PreparedQuery, Result, Utils
- \\ SQLite3 \\ Builder, Connection, Forge, PreparedQuery, Result, Utils
- Debug
- \\ Exceptions, Iterator, Timer, Toolbar
- \\ Toolbar \\ Collectors...
- Email
- \\ Email
- Events
- \\ Events
- Files
- \\ File
- Filters
- \\ FilterInterface, Filters
- Format
- \\ FormatterInterface, JSONFormatter, XMLFormatter
- HTTP
- \\ CLIRequest, CURLRequest, ContentSecurityPolicy, Header,
IncomingRequest, Message, Negotiate, Request, RequestInterface,
Response, ResponseInterface, URI, UserAgent
- \\ Files \\ FileCollection, UploadedFile, UploadedFileInterface
- Helpers
- ... array, cookie, date, filesystem, form, html, inflector, number,
security, text, url
- Honeypot
- \\ Honeypot
- I18n
- \\ Time, TimeDifference
- Images
- \\ Image, ImageHandlerInterface
- \\ Handlers ... Base, GD, ImageMagick
- Language
- \\ Language
- Log
- Logger, LoggerAwareTrait
- \\ Handlers ... Base, ChromeLogger, File, HandlerInterface
- Pager
- \\ Pager, PagerInterface, PagerRenderer
- Router
- \\ RouteCollection, RouteCollectionInterface, Router, RouterInterface
- Security
- \\ Security
- Session
- \\ Session, SessionInterface
- \\ Handlers ... Base, File, Memcached, Redis
- Test
- \\ CIDatabaseTestCase, CIUnitTestCase, FeatureResponse, FeatureTestCase, ReflectionHelper
- \\ Filters \\ CITestStreamFilter
- ThirdParty (bundled)
- \\ Kint (for \\Debug)
- \\ PSR \\ Log (for \\Log)
- \\ ZendEscaper \\ Escaper (for \\View)
- Throttle
- \\ Throttler, ThrottlerInterface
- Typography
- \\ Typography
- Validation
- \\ CreditCardRules, FileRules, FormatRules, Rules, Validation, ValidationInterface
- View
- \\ Cell, Filters, Parser, Plugins, RendererInterface, View
::

.
├── API/
│ └── ResponseTrait
├── Autoloader/
│ └── AutoLoader, FileLocator
├── CLI/
│ └── BaseCommand, CLI, CommandRunner, Console
├── Cache/
│ ├── CacheFactory, CacheInterface
│ └── Handlers/
│ └── Dummy, File, Memcached, Predis, Redis, Wincache
├── Commands/
│ ├── Help, ListCommands
│ ├── Database/
│ │ └── CreateMigration, MigrateCurrent, MigrateLatest, MigrateRefresh, MigrateRollback, MigrateStatus,
│ │ MigrateVersion, Seed
│ ├── Server/
│ │ └── Serve
│ ├── Sessions/
│ │ └── CreateMigration
│ └── Utilities/
│ └── Namespaces, Routes
├── Config/
│ └── AutoloadConfig, BaseConfig, BaseService, Config, DotEnv, ForeignCharacters, Routes, Services, View
├── Database/
│ ├── BaseBuilder, BaseConnection, BasePreparedQuery, BaseResult, BaseUtils, Config, ConnectionInterface,
│ │ Database, Forge, Migration, MigrationRunner, PreparedQueryInterface, Query, QueryInterface,
│ │ ResultInterface, Seeder
│ ├── MySQLi/
│ │ └── Builder, Connection, Forge, PreparedQuery, Result
│ ├── Postgre/
│ │ └── Builder, Connection, Forge, PreparedQuery, Result, Utils
│ └── SQLite3/
│ └── Builder, Connection, Forge, PreparedQuery, Result, Utils
├── Debug/
│ ├── Exceptions, Iterator, Timer, Toolbar
│ └── Toolbar/
│ └── Collectors...
├── Email/
│ └── Email
├── Events/
│ └── Events
├── Files/
│ └── File
├── Filters/
│ └── FilterInterface, Filters
├── Format/
│ └── FormatterInterface, JSONFormatter, XMLFormatter
├── HTTP/
│ ├── CLIRequest, CURLRequest, ContentSecurityPolicy, Header, IncomingRequest, Message, Negotiate, Request,
│ │ RequestInterface, Response, ResponseInterface, URI, UserAgent
│ └── Files/
│ └── FileCollection, UploadedFile, UploadedFileInterface
├── Helpers/
│ └── array, cookie, date, filesystem, form, html, inflector, number, security, text, url
├── Honeypot/
│ └── Honeypot
├── I18n/
│ └── Time, TimeDifference
├── Images/
│ ├── Image, ImageHandlerInterface
│ └── Handlers/
│ └── Base, GD, ImageMagick
├── Language/
│ └── Language
├── Log/
│ ├── Logger, LoggerAwareTrait
│ └── Handlers/
│ └── Base, ChromeLogger, File, HandlerInterface
├── Pager/
│ └── Pager, PagerInterface, PagerRenderer
├── Router/
│ └── RouteCollection, RouteCollectionInterface, Router, RouterInterface
├── Security/
│ └── Security
├── Session/
│ ├── Session, SessionInterface
│ └── Handlers/
│ └── Base, File, Memcached, Redis
├── Test/
│ ├── CIDatabaseTestCase, CIUnitTestCase, FeatureResponse, FeatureTestCase, ReflectionHelper
│ └── Filters/
│ └── CITestStreamFilter
├── ThirdParty/ (bundled)
│ ├── Kint (for Debug)
│ ├── PSR/
│ │ └── Log (for Log)
│ └── ZendEscaper/
│ └── Escaper (for View)
├── Throttle/
│ └── Throttler, ThrottlerInterface
├── Typography/
│ └── Typography
├── Validation/
│ └── CreditCardRules, FileRules, FormatRules, Rules, Validation, ValidationInterface
└── View/
└── Cell, Filters, Parser, Plugins, RendererInterface, View
Loading