syntax/docs.html at main · pronpy/syntax · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta
      name="description"
      content="Organization documentation for Pronpy members and contributors."
    >
    <title>Organization Docs | Pronpy</title>
    <link rel="icon" href="data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 64 64'%3E%3Crect width='64' height='64' rx='10' fill='%23cbece4'/%3E%3Cpath d='M16 19h32v26H16z' fill='%23ffffff' stroke='%23172022' stroke-width='4'/%3E%3Cpath d='M23 29h18M23 36h12' stroke='%23172022' stroke-width='4'/%3E%3C/svg%3E">
    <link rel="stylesheet" href="styles.css">
  </head>
  <body>
    <header class="site-header">
      <a class="brand" href="index.html" aria-label="Pronpy home">
        <span class="brand-mark" aria-hidden="true">SS</span>
        <span>Pronpy</span>
      </a>
      <nav class="site-nav gooey-nav" aria-label="Primary navigation" data-gooey-nav>
        <ul>
          <li><a href="index.html#apis">APIs</a></li>
          <li><a href="index.html#workflow">Workflow</a></li>
          <li class="active"><a href="docs.html" aria-current="page">Organization Docs</a></li>
        </ul>
        <span class="gooey-effect gooey-filter" aria-hidden="true"></span>
        <span class="gooey-effect gooey-text" aria-hidden="true"></span>
      </nav>
    </header>

    <main>
      <section class="docs-hero" aria-labelledby="docs-hero-title">
        <div class="section-inner docs-hero-grid">
          <div class="reveal">
            <p class="eyebrow">Organization handbook</p>
            <h1 id="docs-hero-title">Docs for public API teams.</h1>
            <p>
              Use this page to keep member access, repository standards, launch
              readiness, and security expectations easy to follow.
            </p>
          </div>
          <div class="docs-panel reveal" aria-label="Organization snapshot">
            <span>Current mode</span>
            <strong>Public collaboration</strong>
            <p>Repos stay open, docs stay readable, and maintainers keep decisions visible.</p>
          </div>
        </div>
      </section>

      <section class="section section-white" aria-labelledby="access-title">
        <div class="section-inner docs-grid">
          <article class="card doc-card reveal" id="access">
            <span class="doc-index">01</span>
            <h2 class="card-title" id="access-title">Member Access</h2>
            <p class="small-desc">
              Invite contributors by exact GitHub username. Start with member access,
              then promote only trusted maintainers who need organization settings.
            </p>
            <div class="go-corner" aria-hidden="true">
              <div class="go-arrow">→</div>
            </div>
          </article>
          <article class="card doc-card reveal">
            <span class="doc-index">02</span>
            <h2 class="card-title">Repository Standards</h2>
            <p class="small-desc">
              Each repo should include setup steps, API route docs, environment variable
              names, deployment notes, a license, and a security contact path.
            </p>
            <div class="go-corner" aria-hidden="true">
              <div class="go-arrow">→</div>
            </div>
          </article>
          <article class="card doc-card reveal">
            <span class="doc-index">03</span>
            <h2 class="card-title">API Launch Checklist</h2>
            <p class="small-desc">
              Before publishing, confirm the landing README, examples, health route,
              error format, and deployment workflow are accurate.
            </p>
            <div class="go-corner" aria-hidden="true">
              <div class="go-arrow">→</div>
            </div>
          </article>
          <article class="card doc-card reveal">
            <span class="doc-index">04</span>
            <h2 class="card-title">Review Flow</h2>
            <p class="small-desc">
              Keep pull requests focused. Ask for review when behavior changes, tests
              are added, or public API responses are updated.
            </p>
            <div class="go-corner" aria-hidden="true">
              <div class="go-arrow">→</div>
            </div>
          </article>
          <article class="card doc-card reveal">
            <span class="doc-index">05</span>
            <h2 class="card-title">Security</h2>
            <p class="small-desc">
              Never commit secrets. Use repository secrets for deploy tokens, rotate
              leaked keys immediately, and document required credentials by name only.
            </p>
            <div class="go-corner" aria-hidden="true">
              <div class="go-arrow">→</div>
            </div>
          </article>
          <article class="card doc-card reveal">
            <span class="doc-index">06</span>
            <h2 class="card-title">SAML Readiness</h2>
            <p class="small-desc">
              Enable SAML only after identity-provider details are tested. Keep SAML
              enforcement off until every active member has authenticated.
            </p>
            <div class="go-corner" aria-hidden="true">
              <div class="go-arrow">→</div>
            </div>
          </article>
        </div>
      </section>
    </main>

    <footer class="site-footer">
      <span>Pronpy Docs</span>
      <a href="https://github.com/pronpy">Organization on GitHub</a>
    </footer>

    <script type="module" src="main.js"></script>
  </body>
</html>