Skip to content
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.

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

[docs] Move all Docs to separate repository #11263

Merged
merged 1 commit into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/documentation_bug_report.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/actions/file-change-determinator/action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ runs:
uses: fkirc/skip-duplicate-actions@v5
with:
skip_after_successful_duplicate: false # Don't skip if the action is a duplicate (this may cause false positives)
paths_ignore: '["**/*.md", "developer-docs-site/**"]'
paths_ignore: '["**/*.md"]'
15 changes: 0 additions & 15 deletions .github/workflows/lint-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,21 +51,6 @@ jobs:
- run: echo "Skipping general lints! Unrelated changes detected."
if: needs.file_change_determinator.outputs.only_docs_changed == 'true'

# Run the docs linter. This is a PR required job.
docs-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version-file: .node-version
- uses: pnpm/action-setup@v2
- run: pnpm lint
working-directory: developer-docs-site
- run: sudo apt update -y && sudo apt install -y aspell aspell-en
- run: pnpm spellcheck
working-directory: developer-docs-site

# Run the crypto hasher domain separation checks
rust-cryptohasher-domain-separation-check:
needs: file_change_determinator
Expand Down
1 change: 0 additions & 1 deletion developer-docs-site/.gitattributes

This file was deleted.

20 changes: 0 additions & 20 deletions developer-docs-site/.gitignore

This file was deleted.

13 changes: 0 additions & 13 deletions developer-docs-site/.prettierignore

This file was deleted.

112 changes: 1 addition & 111 deletions developer-docs-site/README.md
Original file line number Diff line number Diff line change
@@ -1,113 +1,3 @@
# Developer Documentation

- [Installation](#installation)
- [Requirements](#requirements)
- [Fork and clone the Aptos repo](#fork-and-clone-the-aptos-repo)
- [Build and serve the docs locally](#build-and-serve-the-docs-locally)
- [Build static html files](#build-static-html-files)
- [Debug/Format files](#debugging)

This Aptos Developer Documentation is built using [Docusaurus 2](https://docusaurus.io/) and displayed on https://aptos.dev/. Follow the below steps to build the docs locally and test your contribution.

We now use [lychee-broken-link-checker](https://github.com/marketplace/actions/lychee-broken-link-checker) to check for broken links in the GitHub Markdown. We are a corresponding link checker for pages on Aptos.dev.

With results visible at:
https://github.com//aptos-labs/aptos-core/actions/workflows/links.yml


## Installation

**IMPORTANT**: These installation steps apply to macOS environment.

### Requirements

Before you proceed, make sure you install the following tools.

- Install [Node.js](https://nodejs.org/en/download/) by executing the below command on your Terminal:

```
brew install node
```

- Install the latest [pnpm](https://pnpm.io/installation) by executing the below command on your Terminal:

```
curl -fsSL https://get.pnpm.io/install.sh | sh -
```

## Clone the Aptos repo

```
git clone https://github.com/aptos-labs/aptos-core.git

```

## Build and serve the docs locally

1. `cd` into the `developer-docs-site` directory in your clone.

```
cd aptos-core/developer-docs-site
```
2. Run `pnpm`.

```
pnpm install
```
This step will configure the Docusaurus static site generator.

3. Start the server locally. This will also open the locally built docs in your default browser.

> **NOTE**: This step will not generate static html files, but will render the docs dynamically.

```
pnpm start
```

4. See your changes staged at: http://localhost:3000/

5. Create a pull request with your changes as described in our [Contributing](https://github.com/aptos-labs/aptos-core/blob/main/CONTRIBUTING.md) README.

## (Optional) Build static html files

Execute the below steps if you want to generate static html documentation files. A `build` directory will be created with the static html files and assets contained in it.

1. Make sure you install dependencies.

```
pnpm install
```
2. Build static html files with pnpm.

```
pnpm build
```

This command generates static html content and places it in the `build` directory.

3. Finally, use the below command to start the documentation server on your localhost.

```
pnpm run serve
```

## Debugging

Fix formatting issues by running:

```
pnpm fmt
```

## Regenerating contributors
The src/contributors.json file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.

In order to generate the contributor map you must authenticate with GitHub. The best way to do that is using GitHub CLI ([installation guide(https://github.com/cli/cli#installation)]). Once you have the GitHub CLI installed, you can run the following command to authenticate:
```
gh auth login --scopes read:user,user:email
```

Once that is done, you can generate the map with this command:
```
pnpm contributors
```
This has been moved to https://github.com/aptos-labs/developer-docs
3 changes: 0 additions & 3 deletions developer-docs-site/babel.config.js

This file was deleted.

9 changes: 0 additions & 9 deletions developer-docs-site/docs/CODEOWNERS

This file was deleted.

40 changes: 0 additions & 40 deletions developer-docs-site/docs/apis/aptos-labs-developer-portal.md

This file was deleted.

83 changes: 0 additions & 83 deletions developer-docs-site/docs/apis/fullnode-rest-api.md

This file was deleted.

34 changes: 0 additions & 34 deletions developer-docs-site/docs/apis/index.md

This file was deleted.

Loading
Loading