Skip to content
This repository was archived by the owner on Jan 20, 2025. It is now read-only.

Commit bcecb20

Browse files
authored
Final CI process and docs improvements (#105)
* Final CI process and docs improvements * README update
1 parent fda11be commit bcecb20

File tree

6 files changed

+9
-68
lines changed

6 files changed

+9
-68
lines changed

.circleci/config.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,6 @@ workflows:
309309
- mdoc
310310
filters:
311311
branches:
312-
only:
313-
- master
312+
ignore: /.*/
314313
tags:
315314
only: /^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/

CONTRIBUTING.md

-15
This file was deleted.

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
High-performance, purely-functional library for building, composing, and supervising typed actors based on ZIO.
77

88
# Documentation
9-
Coming soon when its ready it will be here: [ZIO Actors Microsite](https://zio.github.io/zio-actors/)
9+
[ZIO Actors Microsite](https://zio.github.io/zio-actors/)
1010

1111
# Contributing
12-
[Documentation for contributors](CONTRIBUTING.md)
12+
[Documentation for contributors](https://zio.github.io/zio-actors/docs/about/about_contributing)
1313

1414
## Code of Conduct
1515

16-
See the [Code of Conduct](./code_of_conduct.md)
16+
See the [Code of Conduct](https://zio.github.io/zio-actors/docs/about/about_coc)
1717

1818
## Support
1919

code_of_conduct.md

-46
This file was deleted.

docs/overview/index.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ Here's list of contents available:
1515
Include ZIO Actors in your project by adding the following to your `build.sbt`:
1616

1717
```scala mdoc:passthrough
18+
1819
println(s"""```""")
1920
if (zio.actors.BuildInfo.isSnapshot)
2021
println(s"""resolvers += Resolver.sonatypeRepo("snapshots")""")
21-
println(s"""libraryDependencies += "dev.zio" %% "zio-actors" % "${zio.actors.BuildInfo.version}""")
22+
println(s"""libraryDependencies += "dev.zio" %% "zio-actors" % "${zio.actors.BuildInfo.version}"""")
2223
println(s"""```""")
23-
```
2424

25+
```

website/siteConfig.js

+2
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ const siteConfig = {
9999
cornerOffset: 100,
100100
},
101101

102+
customDocsPath: 'zio-actors-docs/target/mdoc',
103+
102104
// You may provide arbitrary config keys to be used as needed by your
103105
// template. For example, if you need your repo's URL...
104106
// repoUrl: 'https://github.com/facebook/test-site',

0 commit comments

Comments
 (0)