IntersectMBO
Docs revamp
This Draft PR is for the Plutus Core Plutus Tx documentation revamp project. I'll use nested PRs within this Draft PR until the docs revamp project reaches a to-be-defined level of maturity to merge with master.
- [x] Establish new top-level organizational structure
- [x] Port over all of the existing content from the read-the-docs site to this new top-level structure.
- [ ] Create a Developer onboarding and quick setup guide
- [x] Draft has been reviewed a few times, getting pretty close to a complete doc
- [ ] Need to align on the most appropriate first contract example to use
- [ ] Need to align a bit more on scope
- [ ] Write an updated Introduction section for review and discussion
- [x] Work with web dev team to work out new docs platform requirements
- [ ] Do a deep dive on all the content to improve organization and ease of readability. This is a larger and ongoing aspect of the documentation work that I plan to prioritize in coordination with the team after we are up and live with the new docs platform.
- [x] Write up a list of FAQs for review
- [ ] Some feedback needs to be incorporated
- [ ] The questions are written, but the answers to the questions will be written at a later stage
- [ ] Import all the docs into the new docs platform as soon as the new platform is available
- [ ] Test the docs in the new platform to make sure links work, navigation is clear
Is there a particular reason to use md instead of rst? I'm not sure whether md allows importing code from Haskell modules like rst does.
@zliu41 Is there a particular reason to use md instead of rst? I'm not sure whether md allows importing code from Haskell modules like rst does.
I'm working with the web dev team to determine whether we will stay with Read the docs using .rst files or Docusaurus where I would use .md files. So for now I'm using .md until we know what platform we'll be using for the revamp. The code block inclusion question is top of mind in our discussion with the web dev team.
@zliu41 I did a partial review. Note that when we write docs the style we adopt is to write each sentence on a separate line.
Thanks for reminding me about writing each sentence on a separate line. I will follow that practice.
