Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit c5e60f8

Browse files
committed
Update Readme
1 parent 4899c3b commit c5e60f8

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
11
# Page Builder developer documentation
22

3-
This repo is the future home of all Page Builder developer documentation.
3+
This project contains the source code of the Page Builder documentation for Adobe Commerce and Magento Open Source developer documentation website.
4+
5+
> **Important update**
6+
>
7+
> Adobe Commerce and Magento Open Source 2.4.x documentation has been migrated to Adobe sites. See our new landing pages to access the most current information.
8+
>
9+
>[Adobe Commerce Developer Documentation](https://developer.adobe.com/commerce/docs/) (Adobe Developer site)—Develop, customize, integrate, extend, and use advanced capabilities
10+
>
11+
>[Adobe Commerce Documentation](https://experienceleague.adobe.com/docs/commerce.html) (Adobe Experience League)—Plan, implement, operate, upgrade, and maintain your Commerce projects
12+
>
13+
> Some content was consolidated or moved to different guides. If you have trouble finding a topic, see the [Migrated topics](https://commerce-docs.github.io/devdocs-archive/migrated-topics.html).
14+
>
15+
> We welcome contributions to migrated content! You can find similar links to GitHub on the Adobe sites.
16+
17+
## Build the docs
18+
19+
To build this repo locally:
20+
21+
1. Clone the [magento/devdocs](https://github.com/magento/devdocs) repo.
22+
23+
We use custom automation in the magento/devdocs repo to clone and build MBI docs. This automation will not work if you do not first clone the magento/devdocs repo.
24+
25+
1. Initialize the PB docs repo using rake:
26+
27+
```shell
28+
rake init
29+
```
30+
31+
1. Build the site:
32+
33+
```shell
34+
rake preview
35+
```
36+
37+
## Archived docs
38+
39+
To view the archived documentation, see <https://commerce-docs.github.io/devdocs-archive/>.

0 commit comments

Comments
 (0)