Skip to content

Commit 7d1bff9

Browse files
author
Kayce Basques
committed
Tidy up the homepage
1 parent d6c6cef commit 7d1bff9

File tree

6 files changed

+87
-101
lines changed

6 files changed

+87
-101
lines changed

analytics/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1+
.. _analytics:
2+
13
=========
24
Analytics
35
=========
46

7+
* :ref:`sheets`. This tutorial shows you how to use Google Apps Script to
8+
export your Google Analytics data to Google Sheets. The data automatically
9+
updates every night. There’s also a custom menu item within Sheets to update
10+
the data on-demand. You can also optionally also expose the data over HTTPS
11+
to the public internet.
12+
513
.. toctree::
614
:maxdepth: 1
15+
:hidden:
716

817
sheets

index.rst

Lines changed: 2 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@ technicalwriting.dev
66

77
Field notes from the frontier of technical writing.
88

9-
.. _categories:
9+
Topics:
1010

11-
----------
12-
Categories
13-
----------
11+
* :ref:`analytics`
1412

1513
* :ref:`links`
1614

@@ -20,103 +18,6 @@ Categories
2018

2119
* :ref:`strategy`
2220

23-
.. _analytics:
24-
25-
---------
26-
Analytics
27-
---------
28-
29-
* :ref:`sheets`. This tutorial shows you how to use Google Apps Script to
30-
export your Google Analytics data to Google Sheets. The data automatically
31-
updates every night. There’s also a custom menu item within Sheets to update
32-
the data on-demand. You can also optionally also expose the data over HTTPS
33-
to the public internet.
34-
35-
.. _links:
36-
37-
-----
38-
Links
39-
-----
40-
41-
* :ref:`link-text-automation`. A killer feature from Sphinx that more docs systems
42-
should adopt.
43-
44-
* :ref:`pdf`. Just append ``#page=X`` to your URL, where ``X`` is a placeholder
45-
for the page you want to link to.
46-
47-
* :ref:`intertwingularity`. I’m building a web crawler so that I can track how pages in my docs
48-
site link to each other and to the outside web more broadly. If a lot of my docs pages link to
49-
some particular page, then that page is probably important.
50-
51-
.. _ml:
52-
53-
----------------
54-
Machine learning
55-
----------------
56-
57-
.. _embeddings:
58-
59-
Embeddings
60-
==========
61-
62-
* :ref:`underrated`. Machine learning (ML) has the potential to
63-
advance the state of the art in technical writing. No, I'm not talking
64-
about text generation models. The ML technology that might end up having the biggest
65-
impact on technical writing is **embeddings**. What embeddings offer to technical writers is
66-
**the ability to discover connections between texts at previously impossible scales**.
67-
68-
* :ref:`tasks`.
69-
70-
* :ref:`bookmarks`. Embeddings-related papers, projects, etc.
71-
72-
.. _ml-reviews:
73-
74-
Yearly reviews
75-
==============
76-
77-
* :ref:`ml-reviews-2024`.
78-
79-
* :ref:`ml-reviews-2023`.
80-
81-
Miscellaneous
82-
=============
83-
84-
* :ref:`pocketflow`.
85-
86-
* :ref:`gn`. I used Gemini 2.0 Flash and a little Python to automate
87-
the process of removing code from over 200 GN build files. Here's how it
88-
went.
89-
90-
* :ref:`hyperlint`.
91-
92-
.. _sphinx:
93-
94-
------
95-
Sphinx
96-
------
97-
98-
* :ref:`link-text-automation`. A killer feature from Sphinx that more docs systems
99-
should adopt.
100-
101-
* :ref:`sphazel-context`.
102-
103-
* :ref:`sphazel-tutorial`.
104-
105-
* :ref:`incremental`.
106-
107-
.. _strategy:
108-
109-
--------
110-
Strategy
111-
--------
112-
113-
* :ref:`challenges`. There are 3 intractable challenges in technical writing.
114-
I do not believe we will ever be able to completely solve these challenges
115-
using only the practices and technologies of the 2010s.
116-
117-
* :ref:`decisions`. Docs should aim to help people decide what to do.
118-
Only documenting procedures is usually not enough.
119-
12021
.. toctree::
12122
:hidden:
12223

links/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
1+
.. _links:
2+
13
=====
24
Links
35
=====
46

7+
* :ref:`link-text-automation`. A killer feature from Sphinx that more docs systems
8+
should adopt.
9+
10+
* :ref:`pdf`. Just append ``#page=X`` to your URL, where ``X`` is a placeholder
11+
for the page you want to link to.
12+
13+
* :ref:`intertwingularity`. I’m building a web crawler so that I can track how pages in my docs
14+
site link to each other and to the outside web more broadly. If a lot of my docs pages link to
15+
some particular page, then that page is probably important.
16+
517
.. toctree::
618
:maxdepth: 1
19+
:hidden:
720

821
automation
922
intertwingularity

ml/index.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,47 @@
1+
.. _ml:
2+
13
================
24
Machine learning
35
================
46

7+
.. _embeddings:
8+
9+
----------
10+
Embeddings
11+
----------
12+
13+
* :ref:`underrated`. Machine learning (ML) has the potential to
14+
advance the state of the art in technical writing. No, I'm not talking
15+
about text generation models. The ML technology that might end up having the biggest
16+
impact on technical writing is **embeddings**. What embeddings offer to technical writers is
17+
**the ability to discover connections between texts at previously impossible scales**.
18+
19+
* :ref:`tasks`.
20+
21+
* :ref:`bookmarks`. Embeddings-related papers, projects, etc.
22+
23+
.. _ml-reviews:
24+
25+
--------------
26+
Yearly reviews
27+
--------------
28+
29+
* :ref:`ml-reviews-2024`.
30+
31+
* :ref:`ml-reviews-2023`.
32+
33+
-------------
34+
Miscellaneous
35+
-------------
36+
37+
* :ref:`pocketflow`.
38+
39+
* :ref:`gn`. I used Gemini 2.0 Flash and a little Python to automate
40+
the process of removing code from over 200 GN build files. Here's how it
41+
went.
42+
43+
* :ref:`hyperlint`.
44+
545
.. -------------
646
.. Uncategorized
747
.. -------------
@@ -27,6 +67,7 @@ Machine learning
2767
2868
.. toctree::
2969
:maxdepth: 1
70+
:hidden:
3071

3172
embeddings/bookmarks
3273
embeddings/overview

sphinx/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1+
.. _sphinx:
2+
13
======
24
Sphinx
35
======
46

7+
* :ref:`link-text-automation`. A killer feature from Sphinx that more docs systems
8+
should adopt.
9+
10+
* :ref:`sphazel-context`.
11+
12+
* :ref:`sphazel-tutorial`.
13+
14+
* :ref:`incremental`.
15+
516
.. toctree::
617
:maxdepth: 1
18+
:hidden:
719

820
bazel/tutorial
921
bazel/context

strategy/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1+
.. _strategy:
2+
13
========
24
Strategy
35
========
46

7+
* :ref:`challenges`. There are 3 intractable challenges in technical writing.
8+
I do not believe we will ever be able to completely solve these challenges
9+
using only the practices and technologies of the 2010s.
10+
11+
* :ref:`decisions`. Docs should aim to help people decide what to do.
12+
Only documenting procedures is usually not enough.
13+
514
.. toctree::
615
:maxdepth: 1
16+
:hidden:
717

818
challenges
919
decisions

0 commit comments

Comments
 (0)