Skip to content

Commit

Permalink
remove spec stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe committed Feb 21, 2023
1 parent 94d861c commit 73c19f1
Show file tree
Hide file tree
Showing 84 changed files with 43 additions and 8,557 deletions.
30 changes: 0 additions & 30 deletions .github/workflows/deploy-spec.yml

This file was deleted.

6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ nunitresults.xml
.nyc_output/
coverage/

# VS Code
.vscode

# Intellij
.idea/

style-conversion

# Mac
.DS_Store
18 changes: 0 additions & 18 deletions .vscode/launch.json

This file was deleted.

13 changes: 1 addition & 12 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
{
// Configure glob patterns of file paths to exclude from file watching. Patterns must match on absolute paths (i.e. prefix with ** or the full path to match properly). Changing this setting requires a restart. When you experience Code consuming lots of cpu time on startup, you can exclude large folders to reduce the initial load.
"files.exclude": {
"**/.git": true,
"**/.svn": true,
"**/.hg": true,
"**/CVS": true,
"**/.DS_Store": true,
"**/versions/[0-9]**/**": true
},
"prettier": false,
"editor.formatOnSave": false,
"liveServer.settings.port": 5502
"liveServer.settings.port": 5504
}
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sidetree
# Sidetree Reference Implementation

This repository contains both the blockchain-agnostic Sidetree specification and a Node.js based reference implementation.

Expand All @@ -8,21 +8,6 @@ See the [latest spec](https://identity.foundation/sidetree/spec/) for the full S

See the [API spec](https://identity.foundation/sidetree/api/) for the full API specification to interact with a Sidetree node.

### Specification Editing/Contributions:

1. Clone the repo.
2. Create a topic branch for your spec contributions.
3. run `npm install`
4. run `npm run spec:edit`
5. If you see errors like `UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, open './www/spec/index.html'`... create the missing directories and files and try again (they will be overwritten).
6. Type `npx serve .` in the root directory and open `http://localhost:5000/www/spec`.
7. Modify files in the `spec/markdown/` directory to make changes, refresh to see changes.
8. Do not commit build assets.
9. Try and make blocks of text small so that changes can be suggested easily on specific lines.
10. When you are happy with your changes, commit to your topic branch and open a Pull Request on GitHub and reviewers will be alerted to review for a potential merge.
11. Make sure to tag people continuously to ensure your PR is reviewed in a timely manner.
12. PRs that sit open without comments / reviews, will be closed at the editors discretion.

## Reference Implementation

![CI](https://github.com/decentralized-identity/sidetree/workflows/CI/badge.svg)
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title: [Sidetree]
description:
[
Sidetree Specification and Reference Implementation,
Sidetree Reference Implementation,
]
# google_analytics: [Your Google Analytics tracking ID]
# google_analytics: [Your Google Analytics tracking ID]
157 changes: 0 additions & 157 deletions docs/api/content.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/api/title.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/bitcoin.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

### Protocol parameters

| Protocol parameters | Description |
| ------------------------------------ | ---------------------------------------------------------|
| valueTimeLockDurationInBlocks | The duration which a value time lock is required to have |
| Protocol parameters | Description |
|-------------------------------|----------------------------------------------------------|
| valueTimeLockDurationInBlocks | The duration which a value time lock is required to have |

### Configuration parameters
* valueTimeLockUpdateEnabled
Expand Down
13 changes: 2 additions & 11 deletions docs/contribution-guidlines.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,12 @@ Where the `type` must be one of the following, indicating the type of change bei

The `scope` defines what is being changed, in this repository the scope **MUST** be one of the following

* **spec**: Changes being made to the Sidetree specification
* **ref-imp**: Changes being made to the Sidetree reference implementation

The `subject` should be a short descriptive statement describing the nature of the change made by the commit.

Full examples

```
feat(ref-imp): add fee calculation algorithm
```

or

```
fix(spec): ambiguity around update operation terminology
feat: add fee calculation algorithm
```

### Breaking changes
Expand All @@ -69,4 +60,4 @@ A helper scripts of `commit` is included in the `package.json` to aid in making

```
npm run commit
```
```
Loading

0 comments on commit 73c19f1

Please sign in to comment.