Repository navigation
Documentation Road Map #8
murraycollingwood
started this conversation in
General
Replies: 5 comments 4 replies
|
@kasparsatke @mringler |
1 reply
|
Hi @kasparsatke
Happy to work with MD, however the MD table didn't allow for multiple lines
in a table cell. MD also didn't support multiple columns. I had to use
HTML in order to get it to display side by side. It was quite painful.
Sure - let's move the documentation roadmap into this discussion.
Cheers
Murray
…On Sat, 6 Dec 2025 at 11:50, kasparsatke ***@***.***> wrote:
@murraycollingwood <https://github.com/murraycollingwood> For the ease of
discussion, I would like to have your markdown file directly integrated in
one of (the/your) comments. I can do or you can do it yourself. That is
what I already suggested in #5 (comment)
<#5 (comment)>
But maybe I just explained it a bit in the wrong way. Look, if you go to
your file
https://github.com/murraycollingwood/perplorm.github.io/blob/crud-update/documentation/00-documentation-map.markdown
and then click on "raw" (menu item on the right), you will see the pure MD
of your file as
https://raw.githubusercontent.com/murraycollingwood/perplorm.github.io/refs/heads/crud-update/documentation/00-documentation-map.markdown
.
Then you can copy this and just paste it into your discussion comment
(e.g. the one I am just replying to). In the preview you will see it
perfectly renders the combined MD + HTML of document to pure HTML - so your
structure table could just live here in the discussion and we all could see
it and react to it.
BTW - Although I have previously said
<perplorm/perpl#60 (reply in thread)>
I find MD a little bit unsuited and underpowered in a lot of use cases, it
shines with quickly ramping up simple tables and lists which are way easier
to write in MD than in HTML if you don't have any special needs. Just
saying as it looks you have formatted a lot of the HTML by hand in your
file, I guess because of the long columns?
What do you think of having your proposed structure directly here?
—
Reply to this email directly, view it on GitHub
<#8 (reply in thread)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABMKQKGTT7V3J5SOOXPJPOD4AID3NAVCNFSM6AAAAACNWZ7W4KVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTKMJXG4ZDGNQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***
com>
--
Murray Collingwood
Focus Computing Pty Ltd
Australia ph 07 3175 0575
New Zealand ph 03 928 1699
http://www.focus-computing.com.au
|
1 reply
Documentation MapCreated to assist with the layout / organisation of the documentation for Perpl Current structure vs Proposed structure
|
2 replies
|
@murraycollingwood I believe we have a lot of work in front of us here. Nevertheless, I would like to proceed with #5 in the meantime. How do we act on the cut content? Put it elsewhere for now - where? You suggest an item |
0 replies
|
@kasparsatke
Yes - but I'm the guy that doesn't like cludges - do it and do it properly
or don't do it at all.
For now we can leave those commented sections in Basic CRUD, we know they
are there, and "yes" when we get to 04 Query we can pull them into that
document.
So apply #5 and I will start on the installation document.
Cheers
Murray
…On Thu, 11 Dec 2025 at 10:23, kasparsatke ***@***.***> wrote:
@murraycollingwood <https://github.com/murraycollingwood> I believe we
have a lot of work in front of us here. Nevertheless, I would like to
proceed with #5 <#5>
in the meantime. How do we act on the cut content? Put it elsewhere for now
- where? You suggest an item 04 query - is that where you want to put
advanced CRUD methods & techniques?
—
Reply to this email directly, view it on GitHub
<#8 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABMKQKEYGXRAVSD6TVXEZVT4BCFMTAVCNFSM6AAAAACNWZ7W4KVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTKMRSGQZTEOA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***
com>
--
Murray Collingwood
Focus Computing Pty Ltd
Australia ph 07 3175 0575
New Zealand ph 03 928 1699
http://www.focus-computing.com.au
|
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
So I've added a "proposed" documentation map. This is a temporary document to discuss the overall plan.
I'm comparing the current documents with a proposed set.
To summarise, and this is important for us to agree on:
I want one set of documents at the top level, covering:
installation
configuration
basic crud
query
active record
transactions
logging
inheritance
migrations
I would then like a reference folder that documents all of the options available. The reference would be split into four parts:
configuration
schema
query
active record
We should have one last folder for behaviors where we provide sufficient detail about how they work and how to implement them retrospectively.
I'm thinking the Cookbook section has to go - the information there should be covered by the reference detail.
What are your thoughts?
All reactions