github
/
boa
mirror of https://github.com/boa-dev/boa.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

Fix documentation links (#2741) 

This PR changes the following:

- Adds a new (very simple) security policy, to comply with GitHub standards
- Changes the internal links of the documentation to point to the new boajs.dev domain
- The developer documentation link now lies in the CONTRIBUTING.md file
pull/2742/head
Iban Eguia Moraza 2 years ago
parent
e9daa3dd8d
commit
6ea4848bb5
11 changed files with 47 additions and 29 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      CHANGELOG.md
  2. 5
      CONTRIBUTING.md
  3. 11
      README.md
  4. 16
      SECURITY.md
  5. 6
      boa_ast/src/lib.rs
  6. 6
      boa_engine/src/lib.rs
  7. 6
      boa_gc/src/lib.rs
  8. 6
      boa_interner/src/lib.rs
  9. 6
      boa_parser/src/lib.rs
  10. 6
      boa_profiler/src/lib.rs
  11. 6
      boa_unicode/src/lib.rs

2
CHANGELOG.md
Unescape View File

@ -1087,7 +1087,7 @@ Cargo has great support for workspaces, so this shouldn't be an issue.
## Benchmarks
We now have [benchmarks which run against master](https://boa-dev.github.io/boa/dev/bench)!
We now have [benchmarks which run against master](https://boajs.dev/boa/dev/bench/)!
Thanks to Github Actions these will run automatically a commit is merged.
Feature enhancements:

5
CONTRIBUTING.md
Unescape View File

@ -104,6 +104,11 @@ be more readable if you disable parallelism with the `-d` flag. All together it
cargo run --release --bin boa_tester -- run -vv -d -s test/language/types/number 2> error.log
```
## Documentation
We have specific documentation for development, updated on each commit to the `main` branch, with all the private
methods visible here: <https://boajs.dev/boa/doc/>
## Communication
We have a Discord server, feel free to ask questions here:

11
README.md
Unescape View File

@ -22,17 +22,14 @@ Currently, it has support for some of the language.
## Live Demo (WASM)
<https://boa-dev.github.io/boa/playground/>
<https://boajs.dev/boa/playground/>
You can get more verbose errors when running from the command line.
## Development documentation
You can check the internal development docs at <https://boa-dev.github.io/boa/doc>.
## Conformance
To know how much of the _ECMAScript_ specification does Boa cover, you can check out results running the _ECMASCript Test262_ test suite [here](https://boa-dev.github.io/boa/test262/).
To know how much of the _ECMAScript_ specification does Boa cover, you can check out results
running the _ECMASCript Test262_ test suite [here](https://boajs.dev/boa/test262/).
## Contributing
@ -124,7 +121,7 @@ See [Milestones](https://github.com/boa-dev/boa/milestones).
## Benchmarks
See [Benchmarks](https://boa-dev.github.io/boa/dev/bench/).
See [Benchmarks](https://boajs.dev/boa/dev/bench/).
## Profiling

16
SECURITY.md
Unescape View File

@ -0,0 +1,16 @@
# Security Policy
## Supported Versions
Until we reach the 1.0 version, we only support the latest 0.x release and the current `main`
branch. You can find the latest release of Boa in the [GitHub releases][gh_releases] page or
on [crates.io][crate].
[gh_releases]: https://github.com/boa-dev/boa/releases
[crate]: https://crates.io/crates/boa_engine/versions
## Reporting a Vulnerability
If you find any potential vulnerability, join our [discord](https://discord.gg/tUFFk9Y) channel
and contact anyone in the _@boa_dev_ group (check the yellow usernames). Explain how to trigger
the vulnerability, where can it be found and any recommendation you might have to fix it.

6
boa_ast/src/lib.rs
Unescape View File

@ -28,9 +28,9 @@
//!
//! [grammar]: https://tc39.es/ecma262/#sec-syntactic-grammar
//! [early]: https://tc39.es/ecma262/#sec-static-semantic-rules
//! [boa-conformance]: https://boa-dev.github.io/boa/test262/
//! [boa-web]: https://boa-dev.github.io/
//! [boa-playground]: https://boa-dev.github.io/boa/playground/
//! [boa-conformance]: https://boajs.dev/boa/test262/
//! [boa-web]: https://boajs.dev/
//! [boa-playground]: https://boajs.dev/boa/playground/
#![doc(
html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",

6
boa_engine/src/lib.rs
Unescape View File

@ -25,9 +25,9 @@
//!
//! [whatwg]: https://console.spec.whatwg.org
//! [ecma-402]: https://tc39.es/ecma402
//! [boa-conformance]: https://boa-dev.github.io/boa/test262/
//! [boa-web]: https://boa-dev.github.io/
//! [boa-playground]: https://boa-dev.github.io/boa/playground/
//! [boa-conformance]: https://boajs.dev/boa/test262/
//! [boa-web]: https://boajs.dev/
//! [boa-playground]: https://boajs.dev/boa/playground/
#![doc(
html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",

6
boa_gc/src/lib.rs
Unescape View File

@ -20,9 +20,9 @@
//! - **`boa_unicode`** - Boa's Unicode identifier.
//! - **`boa_icu_provider`** - Boa's ICU4X data provider.
//!
//! [boa-conformance]: https://boa-dev.github.io/boa/test262/
//! [boa-web]: https://boa-dev.github.io/
//! [boa-playground]: https://boa-dev.github.io/boa/playground/
//! [boa-conformance]: https://boajs.dev/boa/test262/
//! [boa-web]: https://boajs.dev/
//! [boa-playground]: https://boajs.dev/boa/playground/
#![doc(
html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",

6
boa_interner/src/lib.rs
Unescape View File

@ -25,9 +25,9 @@
//! - **`boa_unicode`** - Boa's Unicode identifier.
//! - **`boa_icu_provider`** - Boa's ICU4X data provider.
//!
//! [boa-conformance]: https://boa-dev.github.io/boa/test262/
//! [boa-web]: https://boa-dev.github.io/
//! [boa-playground]: https://boa-dev.github.io/boa/playground/
//! [boa-conformance]: https://boajs.dev/boa/test262/
//! [boa-web]: https://boajs.dev/
//! [boa-playground]: https://boajs.dev/boa/playground/
#![doc(
html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",

6
boa_parser/src/lib.rs
Unescape View File

@ -24,9 +24,9 @@
//! [spec]: https://tc39.es/ecma262
//! [lex]: https://tc39.es/ecma262/#sec-ecmascript-language-lexical-grammar
//! [grammar]: https://tc39.es/ecma262/#sec-ecmascript-language-expressions
//! [boa-conformance]: https://boa-dev.github.io/boa/test262/
//! [boa-web]: https://boa-dev.github.io/
//! [boa-playground]: https://boa-dev.github.io/boa/playground/
//! [boa-conformance]: https://boajs.dev/boa/test262/
//! [boa-web]: https://boajs.dev/
//! [boa-playground]: https://boajs.dev/boa/playground/
#![doc(
html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",

6
boa_profiler/src/lib.rs
Unescape View File

@ -21,9 +21,9 @@
//! - **`boa_icu_provider`** - Boa's ICU4X data provider.
//!
//! [profiler-md]: https://github.com/boa-dev/boa/blob/main/docs/profiling.md
//! [boa-conformance]: https://boa-dev.github.io/boa/test262/
//! [boa-web]: https://boa-dev.github.io/
//! [boa-playground]: https://boa-dev.github.io/boa/playground/
//! [boa-conformance]: https://boajs.dev/boa/test262/
//! [boa-web]: https://boajs.dev/
//! [boa-playground]: https://boajs.dev/boa/playground/
#![doc(
html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",

6
boa_unicode/src/lib.rs
Unescape View File

@ -26,9 +26,9 @@
//! - **`boa_icu_provider`** - Boa's ICU4X data provider.
//!
//! [uax31]: http://unicode.org/reports/tr31
//! [boa-conformance]: https://boa-dev.github.io/boa/test262/
//! [boa-web]: https://boa-dev.github.io/
//! [boa-playground]: https://boa-dev.github.io/boa/playground/
//! [boa-conformance]: https://boajs.dev/boa/test262/
//! [boa-web]: https://boajs.dev/
//! [boa-playground]: https://boajs.dev/boa/playground/
#![doc(
html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",

Write Preview
Loading…
Cancel
Save