Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Create an index.html file when generating a docs build #10242

Merged
merged 2 commits into from
Jun 24, 2021
Merged

Create an index.html file when generating a docs build #10242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
717d1ee
Choose an index.html when generating a docs build
anoadragon453 Jun 23, 2021
dbe43b3
Changelog
anoadragon453 Jun 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ jobs:
mdbook-version: '0.4.9'

- name: Build the documentation
run: mdbook build
# mdbook will only create an index.html if we're including docs/README.md in SUMMARY.md.
# However, we're using docs/README.md for other purposes and need to pick a new page
# as the default. Let's opt for the welcome page instead.
run: |
mdbook build
cp book/welcome_and_overview.html book/index.html

# Deploy to the latest documentation directories
- name: Deploy latest documentation
Expand Down
1 change: 1 addition & 0 deletions changelog.d/10242.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Choose Welcome & Overview as the default page for synapse documentation website.