Skip to content

Commit 08f5d74

Browse files
committed
Moved layout-related things to STYLEGUIDE.
And created there a new "Use of HTML" just for this purpose. Closes #1898.
1 parent c9b6974 commit 08f5d74

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,7 @@ in the [#perl6 IRC channel](https://perl6.org/community/irc).
4141
* Duplicate small pieces of information rather than rely on linking.
4242
* Be explicit about routine signatures. If a method accepts a `*%args`,
4343
but treats some of them specially, list them separately.
44-
* Check out [the styleguide](writing-docs/STYLEGUIDE.md) for further guidance
45-
* For the website: we support the current and previous major releases of Chrome, Firefox,
46-
Internet Explorer (Edge), and Safari. Please test layout changes.
47-
Lacking actual browsers to test in, you can use [browsershots.org](http://browsershots.org)
48-
or [browserstack.com](http://browserstack.com). Ensure the layout looks OK on mobile.
44+
* Check out [the styleguide](writing-docs/STYLEGUIDE.md) for further guidance.
4945

5046
## Writing Code Examples
5147

@@ -148,11 +144,6 @@ docs in a new tab.
148144
You can create index entries and invisible anchors with `X<|thing,category>`.
149145
To make them visible activate debug mode.
150146

151-
### Viewport size
152-
153-
If you change the layout please check different screen sizes. Debug mode will
154-
display the viewport size in the bottom left corner.
155-
156147
### Broken links
157148

158149
To check for broken links use debug mode. Any spotted broken link will be

writing-docs/STYLEGUIDE.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,20 @@ What should be documented? The primary goal of the programmatic documentation
114114
is to cover items that are part of the specification (the roast test suite)
115115

116116
* If something is visible to users of Perl 6 and is in roast: document it.
117-
* If something is visible to users of Perl 6 and is not in roast: check with the dev team (#perl6-dev on freenode) - This might need have a test added (and therefore docs), or it might need to be hidden so users cannot see it.
117+
* If something is visible to users of Perl 6 and is not in roast: check with the dev team (#perl6-dev on freenode) - This might need have a test added (and therefore docs), or it might need to be hidden so users cannot see it.
118118

119119
Future considerations on this line include: documenting things that are rakudo
120120
specific (like "dd"), and documenting which versions of the spec items are
121121
available in.
122+
123+
## Use of HTML
124+
125+
Generally, Pod 6 should be more than enough for any documentation. However, if you need to embed HTML into the documentation after thinking it twice, bear in mind that we support the current and previous major releases of Chrome, Firefox,
126+
Internet Explorer (Edge), and Safari. Please test layout changes.
127+
Lacking actual browsers to test in, you can use [browsershots.org](http://browsershots.org)
128+
or [browserstack.com](http://browserstack.com). Ensure the layout looks OK on mobile.
129+
130+
### Viewport size
131+
132+
If you change the layout please check different screen sizes. Debug mode will
133+
display the viewport size in the bottom left corner.

0 commit comments

Comments
 (0)