Skip to content

Commit ab60c79

Browse files
chore(docs): change stacks-docs-next to stacks-docs (#2250)
* chore(docs): change stacks-docs-next to stacks-docs * chore(docs): remove legacy docs dependencies * fix(docs): resolve docs check errors * fix(docs): remove legacy llms content fetch * ci: update release branch workflow * docs(docs): remove legacy docs navigation guidance * chore(docs): remove obsolete docs ignore rules * docs(docs): update local dev instructions * refactor(docs): use turndown for llms output * fix(docs): clone private docs during build * chore: prune stale gitignore entries * fix(docs): include svelte check in lint * fix(docs): build svelte before docs check * fix auth base url * Revert "fix auth base url" This reverts commit 1c8e191. * fix auth base url… again * chore: trigger ci --------- Co-authored-by: Dan Cormier <dancormierall@gmail.com>
1 parent d288f8b commit ab60c79

582 files changed

Lines changed: 688 additions & 58428 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/main.yml

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ name: CI
22

33
on:
44
push:
5-
branches: [develop, beta, main]
5+
branches: [main, beta]
66
pull_request:
7-
branches: [develop, beta, main]
7+
branches: [main, beta]
88

99
jobs:
1010
build-and-test:
@@ -55,7 +55,7 @@ jobs:
5555

5656
release:
5757
name: Release (latest or beta)
58-
if: github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/beta'
58+
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/beta'
5959
needs: [build-and-test]
6060
runs-on: ubuntu-latest
6161
outputs:
@@ -80,7 +80,7 @@ jobs:
8080
title: "chore(new-release)"
8181
commit: "chore(new-release)"
8282
branch: ${{ github.ref == 'refs/heads/beta' && 'beta' || null }}
83-
createGithubReleases: ${{ github.ref == 'refs/heads/develop' }}
83+
createGithubReleases: ${{ github.ref == 'refs/heads/main' }}
8484
env:
8585
GITHUB_TOKEN: ${{ secrets.STACKS_TOOLING_GH_RW_PAT }}
8686
NPM_TOKEN: ${{ secrets.NPM_API_KEY }}
@@ -96,25 +96,6 @@ jobs:
9696
This is necessary because the PR is updated by github-actions[bot].
9797
This is a technical user which does not trigger actions workflows on push events.
9898
See this GH issue for more details: https://github.com/changesets/action/issues/187
99-
100-
update-docs:
101-
name: Update main site stackoverflow.design
102-
if: ${{ needs.release.outputs.published == 'true' && github.ref == 'refs/heads/develop' }}
103-
needs: [build-and-test, release]
104-
runs-on: ubuntu-latest
105-
steps:
106-
- uses: actions/checkout@v5
107-
- name: 🔄 Update stackoverflow.design docs
108-
run: |
109-
git config --global user.name 'github-actions[bot]'
110-
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
111-
git fetch origin
112-
git checkout production
113-
git merge --no-ff --allow-unrelated-histories origin/develop -m "chore: merge develop into production"
114-
git push origin production
115-
env:
116-
GITHUB_TOKEN: ${{ secrets.STACKS_TOOLING_GH_RW_PAT }}
117-
11899
# cancel the jobs if another workflow is kicked off for the same branch
119100
concurrency:
120101
group: ${{ github.workflow }}-${{ github.ref }}

.gitignore

Lines changed: 15 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,6 @@
1-
# Compiled source #
2-
###################
3-
*.com
4-
*.class
5-
*.dll
6-
*.exe
7-
*.o
8-
*.so
9-
10-
# Packages #
11-
############
12-
# it's better to unpack these files and commit the raw source
13-
# git has its own built in compression methods
14-
*.7z
15-
*.dmg
16-
*.gz
17-
*.iso
18-
*.jar
19-
*.rar
20-
*.tar
21-
22-
# Logs and databases #
23-
######################
1+
# Logs #
2+
########
243
*.log
25-
*.sql
26-
*.sqlite
274

285
# OS generated files #
296
######################
@@ -37,53 +14,33 @@ Thumbs.db
3714
*_rsa
3815
*_rsa.pub
3916

40-
# Sublime #
41-
######################
42-
*.sublime-workspace
43-
44-
# 11ty Site #
45-
###############
46-
# This is compiled by Netlify on its servers, so no need to include it.
47-
_site/
48-
.asset-cache
49-
50-
# Komodo Edit #
51-
###############
52-
*.komodoproject
53-
5417
# NPM #
5518
###############
56-
node_modules
19+
node_modules/
5720

5821
# Compiled CSS/JS #
5922
###############
60-
dist/
61-
/packages/stacks-docs/assets/css/
62-
/packages/stacks-docs/assets/js/stacks.*
63-
/packages/stacks-docs/assets/js/controllers.js
64-
/packages/stacks-docs/assets/js/controllers.js.map
65-
/packages/stacks-docs/assets/js/library.*
23+
/packages/stacks-classic/dist/
24+
/packages/stacks-svelte/netlify/dist/
25+
/packages/stacks-utils/dist/
6626
/build/
27+
28+
# Build caches #
29+
################
6730
.tscache
31+
*.tsbuildinfo
32+
.svelte-kit/
33+
34+
# Private docs are cloned during docs builds and must not be tracked.
35+
/packages/stacks-docs/src/docs/private/
6836

6937
# legacy compiled files -- these are no longer generated, but may still be lingering around
7038
/packages/stacks-classic/lib/css/*.css
7139

72-
# Environment normalization #
73-
###############
74-
/packages/stacks-docs/.bundle
75-
/packages/stacks-docs/vendor/bundle
76-
/packages/stacks-docs/_includes/svg-icons
77-
/packages/stacks-docs/_includes/svg-spots
78-
7940
# Testing Assets #
8041
###############
8142
**/screenshots/**/failed/**
8243

83-
# GitHub Actions #
84-
###############
85-
/.github/main.workflow
86-
8744
# Editors #
8845
###########
8946
/.idea
@@ -92,6 +49,4 @@ dist/
9249
################
9350
**/storybook-static
9451
.eslintcache
95-
*.tsbuildinfo
96-
.svelte-kit
97-
/packages/stacks-svelte/lib/
52+
/packages/stacks-svelte/lib/

.gitmodules

Lines changed: 0 additions & 4 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Draft PRs are welcome for work in progress, but we focus our review time on PRs
9898
```
9999
6. Push your branch and [open a pull request](https://github.com/StackExchange/Stacks/pulls) with a clear title and description.
100100

101-
All pull requests should target the `main` branch. Pull requests targeting `production` will be rejected.
101+
All pull requests should target the `main` branch unless the Stacks team specifically asks you to target a release branch.
102102

103103
## Changesets
104104

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,14 +178,14 @@ We use [changesets](https://github.com/changesets/changesets) to automatize the
178178

179179
- Every time you do work that requires a new release to be published, [add a changesets entry](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) by running `npx changeset` and follow the instructions on screen. (changes that do not require a new release - e.g. changing a test file - don't need a changeset).
180180
- When opening a PR without a corresponding changeset the [changesets-bot](https://github.com/apps/changeset-bot) will remind you to do so. It generally makes sense to have one changeset for PR (if the PR changes do not require a new release to be published the bot message can be safely ignored)
181-
- The [release github workflow](.github/workflows/main.yml) continuously checks if there are new pending changesets in the `beta` branch; if there are, it creates a GH PR (`chore(release)` [see example](https://github.com/StackExchange/apca-check/pull/2)) and continues updating it as more changesets are pushed/merged to the `beta` branch.
182-
- When we are ready to cut a release we need to simply merge the `chore(release)` PR and the release github workflow will take care of publishing the changes to NPM and create a GH release for us. The `chore(release)` PR also give us an opportunity to adjust the automatically generated changelog when necessary (the entry in the changelog file is also what will end up in the GH release notes).
181+
- The [release github workflow](.github/workflows/main.yml) runs on `main` and `beta`. On `beta`, it creates and updates the `chore(release)` PR as pending changesets are merged. On `main`, it publishes the latest release to NPM and creates GitHub releases.
182+
- When we are ready to cut a beta release we merge the `chore(release)` PR. The release github workflow publishes the changes to NPM and gives us an opportunity to adjust the automatically generated changelog before release notes are created.
183183

184184
_The release github workflow only run if the CI workflow (running linter, formatter and tests) is successful: CI is blocking accidental releases_.
185185

186186
_Despite using changesets to communicate the intent of creating releases in a more explicit way, we still follow [conventional commits standards](https://www.conventionalcommits.org/en/v1.0.0/) for keeping our git history easily parseable by the human eye._
187187

188-
Successful releases trigger automatically a new deployment to stackoverflow.design by merging the `main` branch.
188+
Docs are deployed directly from the current release flow; we no longer merge into a `production` branch to publish stackoverflow.design. Normal contribution PRs target `main`.
189189

190190
## License
191191
Code and documentation copyright 2017-2026 Stack Exchange, Inc and released under the [MIT License](/LICENSE.MD).

0 commit comments

Comments
 (0)