You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/README.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Before you begin, make sure you have the following installed on your machine:
11
11
- nx
12
12
- yarn
13
13
14
-
You also need a GitHub account and a fork of the https://github.com/module-federation/core[module-federation/universe] repository.
14
+
You also need a GitHub account and a fork of the https://github.com/module-federation/core[module-federation/core] repository.
15
15
16
16
## Setting up your environment
17
17
@@ -22,7 +22,7 @@ Documentation website consists of 2 applications:
22
22
23
23
To set up your environment, follow these steps:
24
24
25
-
1. Clone your fork of the module-federation/universe repository to your local machine.
25
+
1. Clone your fork of the module-federation/core repository to your local machine.
26
26
2. Navigate to the `apps/docs` folder inside the cloned repository.
27
27
3. Run `npm install` to install the dependencies.
28
28
4. By default, serving\building will pull the changes from the `main` branch. To use it, run `nx run docs:serve`. Along with it there's a `local` configuration, that provides an ability to rely on the files within the filesystem. Can be used by running `nx run docs:serve:local`
@@ -44,7 +44,7 @@ To make changes to the documentation, follow these steps:
44
44
45
45
## Submitting pull requests
46
46
47
-
Once you are happy with your changes, you can submit a pull request to the module-federation/universe repository. A pull request is a way of proposing your changes to be merged into the main branch of the repository.
47
+
Once you are happy with your changes, you can submit a pull request to the module-federation/core repository. A pull request is a way of proposing your changes to be merged into the main branch of the repository.
48
48
49
49
To submit a pull request, follow these steps:
50
50
@@ -54,7 +54,7 @@ To submit a pull request, follow these steps:
54
54
4. Select your fork and branch as the source and the main branch as the destination.
55
55
5. Fill in the title and description of your pull request and click on "Create pull request".
56
56
57
-
Your pull request will be reviewed by the maintainers of the `module-federation/universe` repository as well as by a technical writer who will check your content for accuracy, clarity, and adherence to Google Developers Documentation Style Guide. The technical writer may suggest some changes or improvements to your content before merging it to the main branch. and they will provide feedback or approve it.
57
+
Your pull request will be reviewed by the maintainers of the `module-federation/core` repository as well as by a technical writer who will check your content for accuracy, clarity, and adherence to Google Developers Documentation Style Guide. The technical writer may suggest some changes or improvements to your content before merging it to the main branch. and they will provide feedback or approve it.
0 commit comments