Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Motoko docs revisions & restructure #4512

Merged
merged 118 commits into from
May 1, 2024
Merged

doc: Motoko docs revisions & restructure #4512

merged 118 commits into from
May 1, 2024

Conversation

crusso
Copy link
Contributor

@crusso crusso commented Apr 22, 2024 •
edited
Loading

  • organizes docs into sub-folders, unused docs into doc/md/attic
  • resurrects make preview
  • add some new docs (from portal)
  • splits some old docs into separate files
  • fixes links
  • adjusts doc order in nav bar

This PR is the second step in rebuilding #4494, and applies the edits from #4494 to the already moved source files in #4511, improving the diff and easing review.

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 22, 2024 •
edited
Loading

Comparing from cdab4bf to 3eac853:
The produced WebAssembly code seems to be completely unchanged.

@crusso crusso changed the title manually port changes from docs-updats; mv files deleted there to md/… doc: doc: reconstruct #4494 for better diffs (apply edits to moved files) Apr 22, 2024
@crusso crusso changed the title doc: doc: reconstruct #4494 for better diffs (apply edits to moved files) doc: reconstruct #4494 for better diffs (apply edits to moved files) Apr 22, 2024
@crusso crusso mentioned this pull request Apr 22, 2024
Merged
@jessiemongeon1 jessiemongeon1 mentioned this pull request Apr 22, 2024
Closed
crusso
crusso commented Apr 23, 2024
View reviewed changes
Copy link
Contributor Author

@crusso crusso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff. Added some interim comments.

doc/md/canister-maintenance/compatibility.md Outdated Show resolved Hide resolved
doc/md/canister-maintenance/compatibility.md Outdated Show resolved Hide resolved
doc/md/canister-maintenance/compatibility.md Outdated Show resolved Hide resolved
doc/md/canister-maintenance/compatibility.md Outdated Show resolved Hide resolved
doc/md/canister-maintenance/compatibility.md Outdated Show resolved Hide resolved
doc/md/getting-started/basic-concepts.md Outdated Show resolved Hide resolved
doc/md/getting-started/basic-concepts.md Show resolved Hide resolved
doc/md/getting-started/basic-concepts.md Outdated Show resolved Hide resolved
doc/md/getting-started/basic-concepts.md Outdated Show resolved Hide resolved
doc/md/getting-started/basic-concepts.md Outdated Show resolved Hide resolved
crusso
crusso commented Apr 24, 2024
View reviewed changes
doc/md/reference/style.md Outdated Show resolved Hide resolved
crusso
crusso commented Apr 24, 2024
View reviewed changes
doc/md/reference/style.md Outdated Show resolved Hide resolved
crusso
crusso commented Apr 24, 2024
View reviewed changes
Copy link
Contributor Author

@crusso crusso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More interim comments

doc/md/stable-memory/stablememory.md Outdated Show resolved Hide resolved
doc/md/stable-memory/stablememory.md Outdated Show resolved Hide resolved
doc/md/stable-memory/stable-regions.md Outdated Show resolved Hide resolved
doc/md/stable-memory/stablememory.md Outdated Show resolved Hide resolved
doc/md/stable-memory/stablememory.md Show resolved Hide resolved
doc/md/writing-motoko/control-flow.md Outdated Show resolved Hide resolved
doc/md/writing-motoko/control-flow.md Outdated Show resolved Hide resolved
doc/md/writing-motoko/errors.md Outdated Show resolved Hide resolved
doc/md/getting-started/motoko-introduction.md Outdated Show resolved Hide resolved
doc/md/getting-started/motoko-introduction.md Outdated Show resolved Hide resolved
@crusso crusso changed the base branch from claudio/docs-updates-move to master May 1, 2024 10:53
@crusso crusso changed the base branch from master to claudio/docs-updates-move May 1, 2024 10:54
@crusso crusso marked this pull request as draft May 1, 2024 11:36
mergify bot pushed a commit that referenced this pull request May 1, 2024
@crusso
doc: reorganize doc files (#4511)
ec21df1 
Reconstructs #4494 to ease reviewing.

This PR moves the original files unchanged:

The follow on PR #4512 (based on the PR) manually re-applies the edits from #4494.

#4512 is much easier to review than #4494, tracking changes to the moved files rather than viewing them as completely new files (with fresh content).
@crusso crusso changed the base branch from claudio/docs-updates-move to master May 1, 2024 14:22
@crusso crusso changed the base branch from master to claudio/docs-updates-move May 1, 2024 14:23
@crusso crusso changed the base branch from claudio/docs-updates-move to master May 1, 2024 14:54
@crusso crusso marked this pull request as ready for review May 1, 2024 14:55
@crusso crusso changed the title doc: reconstruct #4494 for better diffs (apply edits to moved files) doc: reorganize and improve docs May 1, 2024
@crusso crusso changed the title doc: reorganize and improve docs doc: Motoko docs revisions & restructure May 1, 2024
@crusso crusso added the automerge-squash When ready, merge (using squash) label May 1, 2024
@mergify mergify bot merged commit eaf444b into master May 1, 2024
11 checks passed
@mergify mergify bot removed the automerge-squash When ready, merge (using squash) label May 1, 2024
@mergify mergify bot deleted the claudio/docs-updates-edits branch May 1, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jessiemongeon1 jessiemongeon1 jessiemongeon1 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@crusso @jessiemongeon1