ladybird/Documentation/README.md

# Ladybird Documentation

Ladybird development moves quickly, so some of these might be out of date. Please let us know if something here is wrong.
If you have any questions that are not answered here or in the [FAQ](FAQ.md), you are welcome to ask on [Discord](../README.md#get-in-touch-and-participate).

## Building and Running
* [Build Instructions](BuildInstructionsLadybird.md)
* [Advanced Build Instructions](AdvancedBuildInstructions.md)
* [Troubleshooting](Troubleshooting.md)
* [Testing](Testing.md)
* [Profiling the Build](BuildProfilingInstructions.md)

## Configuring Editors
* [Android Studio](EditorConfiguration/AndroidStudioConfiguration.md)
* [CLion](EditorConfiguration/CLionConfiguration.md)
* [Emacs](EditorConfiguration/EmacsConfiguration.md)
* [Helix](EditorConfiguration/HelixConfiguration.md)
* [NVim](EditorConfiguration/NvimConfiguration.md)
* [Qt Creator](EditorConfiguration/QtCreatorConfiguration.md)
* [Vim](EditorConfiguration/VimConfiguration.md)
* [VS Code](EditorConfiguration/VSCodeConfiguration.md)

## Development
* [Project Participation](../CONTRIBUTING.md)
* [Code Policy](CodePolicy.md)
* [Coding Style](CodingStyle.md)
* [Common Patterns](Patterns.md)
* [Guidelines for Text in UI](HumanInterfaceGuidelines/Text.md)
* [EventLoop](EventLoop.md)
* [Smart Pointers](SmartPointers.md)
* [String Formatting](StringFormatting.md)

## Browser/LibWeb
* [General Architecture](ProcessArchitecture.md)
* [LibWeb: From Loading to Painting](LibWebFromLoadingToPainting.md)
* [LibWeb: Browsing Contexts and Navigables](BrowsingContextsAndNavigables.md)
* [How to Add a CSS Property](CSSProperties.md)
* [How to Add an IDL File](AddNewIDLFile.md)
* [LibWeb Code Style & Patterns](LibWebPatterns.md)
* [CSS Generated Files](CSSGeneratedFiles.md)
Meta: Update Documentation and CI for repo move 2024-05-30 18:06:21 -03:00			`# Ladybird Documentation`
Documentation: Add a table of contents for Documentation 2022-07-21 11:17:01 -03:00
Everywhere: Update contribution guidelines We've closed down the public PR route: https://ladybird.org/posts/changing-how-we-develop-ladybird/ Update our guidelines and documentation to reflect this. 2026-06-05 05:10:37 -03:00			`Ladybird development moves quickly, so some of these might be out of date. Please let us know if something here is wrong.`
			`If you have any questions that are not answered here or in the [FAQ](FAQ.md), you are welcome to ask on [Discord](../README.md#get-in-touch-and-participate).`
Documentation: Add a table of contents for Documentation 2022-07-21 11:17:01 -03:00
			`## Building and Running`
Documentation: Remove links to outdated guides 2024-06-05 10:04:23 -03:00			`* [Build Instructions](BuildInstructionsLadybird.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 11:17:01 -03:00			`* [Advanced Build Instructions](AdvancedBuildInstructions.md)`
			`* [Troubleshooting](Troubleshooting.md)`
Documentation: Combine testing documentation together Bring together the docs on running tests, with the ones on writing them which were hidden in Browser/Patterns.md I've made a few adjustments while I was at it, because RunningTests.md was a bit outdated and didn't mention `Meta/ladybird.sh test`. It's possible they're still outdated and wrong, but I'm not familiar enough with that area to know. 2024-10-22 11:18:06 -03:00			`* [Testing](Testing.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 11:17:01 -03:00			`* [Profiling the Build](BuildProfilingInstructions.md)`

			`## Configuring Editors`
Documentation: Move editor configuration guides into a subdirectory This makes them a bit easier to find, and also stops them cluttering up the main documentation. 2024-10-22 11:24:25 -03:00			`* [Android Studio](EditorConfiguration/AndroidStudioConfiguration.md)`
			`* [CLion](EditorConfiguration/CLionConfiguration.md)`
			`* [Emacs](EditorConfiguration/EmacsConfiguration.md)`
			`* [Helix](EditorConfiguration/HelixConfiguration.md)`
			`* [NVim](EditorConfiguration/NvimConfiguration.md)`
			`* [Qt Creator](EditorConfiguration/QtCreatorConfiguration.md)`
			`* [Vim](EditorConfiguration/VimConfiguration.md)`
			`* [VS Code](EditorConfiguration/VSCodeConfiguration.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 11:17:01 -03:00
			`## Development`
Everywhere: Update contribution guidelines We've closed down the public PR route: https://ladybird.org/posts/changing-how-we-develop-ladybird/ Update our guidelines and documentation to reflect this. 2026-06-05 05:10:37 -03:00			`* [Project Participation](../CONTRIBUTING.md)`
			`* [Code Policy](CodePolicy.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 11:17:01 -03:00			`* [Coding Style](CodingStyle.md)`
			`* [Common Patterns](Patterns.md)`
Documentation: Add links of all docs that aren't mentioned anywhere 2023-07-15 07:41:13 -03:00			`* [Guidelines for Text in UI](HumanInterfaceGuidelines/Text.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 11:17:01 -03:00			`* [EventLoop](EventLoop.md)`
			`* [Smart Pointers](SmartPointers.md)`
			`* [String Formatting](StringFormatting.md)`

			`## Browser/LibWeb`
Documentation: Flatten the `Browser/` directory Separating out the browser documentation doesn't make much sense now that we are only a browser. :^) 2024-10-22 11:30:16 -03:00			`* [General Architecture](ProcessArchitecture.md)`
			`* [LibWeb: From Loading to Painting](LibWebFromLoadingToPainting.md)`
			`* [LibWeb: Browsing Contexts and Navigables](BrowsingContextsAndNavigables.md)`
Documentation: Document how to add a new CSS property 2025-02-13 17:24:01 -03:00			`* [How to Add a CSS Property](CSSProperties.md)`
Documentation: Flatten the `Browser/` directory Separating out the browser documentation doesn't make much sense now that we are only a browser. :^) 2024-10-22 11:30:16 -03:00			`* [How to Add an IDL File](AddNewIDLFile.md)`
Documentation: Fix broken link in README 2024-11-20 23:04:45 -03:00			`* [LibWeb Code Style & Patterns](LibWebPatterns.md)`
Documentation: Flatten the `Browser/` directory Separating out the browser documentation doesn't make much sense now that we are only a browser. :^) 2024-10-22 11:30:16 -03:00			`* [CSS Generated Files](CSSGeneratedFiles.md)`