Skip to content

Commit 32c4d68

Browse files
committed
docs: update README
1 parent 0ff19ae commit 32c4d68

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,47 @@
1-
# Website
1+
# Dev Rebase
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
[Dev Rebase](https://dev-rebase.github.io) is a collection of concise guides that help developers bridge the gap between local experience and the expectations of international or remote tech roles. It focuses on practical knowledge around tools, workflows, and industry-standard practices used in modern software teams.
44

5-
## Installation
5+
## What Inspired This Project
6+
7+
Many developers — especially those from underrepresented regions or local markets — face challenges not because of a lack of talent, but due to limited exposure to the practices commonly expected in global tech environments. Dev Rebase was created to address this challenge.
8+
9+
The guides cover essential topics and skills that can make a meaningful difference when preparing for remote opportunities or job relocation:
10+
11+
- **Core Skills**: Git, Web Development, Testing.
12+
- **Deployment & Production**: Containerization, CI/CD, Observability.
13+
- **Learn by Doing**: Contributing to Open Source.
14+
- **Learn from Others**: Mentorship, Global Communities.
15+
16+
## Built With
17+
18+
This site is built with [Docusaurus](https://docusaurus.io/), a modern static site generator.
19+
20+
## Getting Started
21+
22+
### Installation
623

724
```bash
825
yarn
926
```
1027

11-
## Local Development
28+
### Local Development
1229

1330
```bash
1431
yarn start
1532
```
1633

1734
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1835

19-
## Build
36+
### Build
2037

2138
```bash
2239
yarn build
2340
```
2441

2542
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2643

27-
## Deployment
44+
### Deployment
2845

2946
Using SSH:
3047

@@ -39,3 +56,7 @@ GIT_USER=<Your GitHub username> yarn deploy
3956
```
4057

4158
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
59+
60+
## Contributing
61+
62+
This is an open source project — contributions are welcome! If you spot errors, have topic suggestions, or want to expand the content, please open an issue or submit a pull request.

0 commit comments

Comments
 (0)